SumItUp

SumItUp is a platform that allows users to generate summaries from various types of content, including audio, images, videos, GIFs, URLs, PDFs and books. It provides users with quick and concise summaries to help them understand the content more efficiently.

Features

• User Authentication: Users can register for an account and log in to access the SumItUp platform.

• Content Summarization:

  • Generate summaries from audio files.
  • Generate summaries from images.
  • Generate summaries from videos.
  • Generate summaries from GIFs.
  • Generate summaries from URLs.
  • Generate summaries from books.
  • Generate summaries from PDFs.

• Token Management: Users can earn tokens by watching ads and spend tokens to opt out of ads.

• Content Search and Filtering: Users can search for books by title and filter search results.

• PDF Generation: Users can generate PDF documents from summaries for easy sharing and saving.

• Personalized Ads: Users are shown personalized ads based on their interests.

User Stories

1. User Authentication:

   • As a user, I want to be able to register for a new account, so I can access the SumItUp platform.
   • As a user, I want to be able to log in to my account, so I can access my personalized content and features.

2. Content Summarization:

   • As a user, I want to be able to generate a summary from an audio file, so I can quickly understand its content.
   • As a user, I want to be able to generate a summary from an image, so I can quickly understand its content.
   • As a user, I want to be able to generate a summary from a video, so I can quickly understand its content.
   • As a user, I want to be able to generate a summary from a GIF, so I can quickly understand its content.
   • As a user, I want to be able to generate a summary from a URL, so I can quickly understand its content.
   • As a user, I want to be able to generate a summary from a book, so I can quickly understand its content.
   • As a user, I want to be able to genrate a summary from a PDF document, so I can quickly understand its content.

3. Token Management:

   • As a user, I want to be able to earn tokens by watching ads, so I can use them to opt out of ads in the future.
   • As a user, I want to be able to spend tokens to opt out of ads, so I can have an ad-free experience.

4. Content Search and Filtering:

   • As a user, I want to be able to search for books by title, so I can find relevant content to summarize.
   • As a user, I want to be able to filter search results by various criteria, so I can find specific types of content.

5. PDF Generation:

   • As a user, I want to be able to generate a PDF document from a summary, so I can easily save or share it.

6. Personalized Ads:

   • As a user, I want to be able to view personalized ads based on my interests, so I can discover relevant products and services.

Technologies Used

• Backend: Node.js, Express.js, MongoDB
• Frontend: React Native
• Testing: Mocha, Chai, Sinon (Backend), Jest, React Testing Library (Frontend)

Setup Instructions

1. Clone the repository: git clone https://github.com/m-a-y-a-n-k/SumItUp.git
2. Navigate to the backend project directory: cd backend
3. Follow the steps in backend README.md
4. Navigate to the frontend project directory: cd frontend
5. Follow the steps in frontend README.md

API Documentation

For detailed API documentation, please refer to the API Documentation section.

License

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