Skip to content

vipulsc/projekt-saaraansh

Repository files navigation

SaaRaansH

SaaRaansH Logo

Elevate your reading. Summarize smarter.

GitHub license PRs Welcome Made with React

⭐ If you find this project helpful, please consider giving it a star on GitHub! ⭐

Overview

Welcome to SaaRaansH — an open-source AI summarizer designed to streamline content consumption effortlessly!

Switch seamlessly between SaaRaansH (English) and सारांश (Hindi), while enjoying a smooth, animated UI. Say goodbye to hours of reading, and let SaaRaansH do the work for you!

✨ Features

  • 📑 Smart Summarization: Generate concise, accurate summaries of lengthy content
  • 🖌️ Modern Interface: Stunning UI with smooth, animated transitions
  • 🌐 Responsive Design: Fully optimized for both desktop and mobile devices
  • 🧩 Open Source: Community-driven project welcoming contributions

🚀 Technology Stack

Technology Description
React Frontend library for building the user interface
JavaScript Core programming language
RapidAPI API integration for content extraction and processing
Tailwind CSS Utility-first CSS framework for styling (v4)
Redux Toolkit State management solution

🛠️ Installation & Setup

  1. Clone the repository

    git clone https://github.com/vipulsc/projekt-saaraansh.git
  2. Navigate to project directory

    cd projekt-saaraansh
  3. Install dependencies

    npm install
  4. Create environment file

    # Create a .env file in the root directory
    touch .env
    
    # Add your RapidAPI key to the .env file
    echo "VITE_RAPIDAPI_ARTICLE_KEY=your_api_key_here" >> .env
  5. Start development server

    npm run dev

Note: You'll need to obtain a RapidAPI key from the RapidAPI website and replace your_api_key_here with your actual API key.

Prerequisites: Node.js (v14+) and npm must be installed on your system.

🤝 Contributing

We welcome contributions from developers of all skill levels! Here's how you can help:

  1. Fork the repository
  2. Create a feature branch
    git checkout -b feature/amazing-feature
  3. Commit your changes
    git commit -m 'Add some amazing feature'
  4. Push to your branch
    git push origin feature/amazing-feature
  5. Open a Pull Request

Feel free to DM or create a request for any problems you encounter.

🎓 Acknowledgements

  • OpenAI: For providing the powerful GPT-4 API that powers our summarization engine
  • RapidAPI: For article extraction and processing capabilities
  • React Community: For building and maintaining excellent tools and libraries
  • Contributors: Everyone who has contributed to making SaaRaansH better!

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.


Built with ❤️ by Vipul

About

SaaRaansH (सारांश) is an open-source AI tool that instantly transforms lengthy articles into concise, readable summaries with a beautiful animated interface.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors