Skip to content

ArshTiwari2004/Recap

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

AI-powered note organization that adapts to your learning style. Capture, connect, and master your study materials effortlessly.

Live Now

GitHub Issues GitHub Forks GitHub Stars Contributors License GitHub commit activity GitHub last commit

πŸ“Œ Overview

Recap is an innovative study companion designed to revolutionize how students organize and interact with their study materials. Our platform leverages artificial intelligence to create an intelligent note-taking ecosystem that grows with your learning journey.

🌟 Key Features

  • Smart Note Organization: Automatic categorization by subject and topic
  • View Your Notes: View all your notes in a organized, customizable way
  • Flashcard Generation: Automatic creation of study cards from your notes which you can revise later
  • OCR Integration: Convert handwritten notes to digital text
  • Audio Transcription: Convert lecture recordings to searchable text
  • Collaborative Learning: Share and create groups with peers and study
  • AI-Powered Insights: Identify knowledge gaps and get personalized recommendations and resources
  • Gamified Learning: Stay motivated with study streaks and interactive quizzes

πŸ–ΌοΈ Screenshots

Landingpage Landing page of Recap

Dashboard Dashboard of RECAP

Flashcards AI-Generated Flashcards in RECAP

πŸ› οΈ Tech Stack

Frontend

React.js Tailwind CSS shadcn UI JavaScript Tesseract.js

Backend

Node.js Firebase Authentication Google OAuth Firebase Firestore Database
Firebase Storage Firebase Cloud Functions Firebase Hosting Firebase Analytics

API Used

Assembly AI API Cohere AI API

DevOps & Deployment

Vercel Git & GitHub Docker Kubernetes

Architecture of RECAP

Architecture

πŸš€ Getting Started

Prerequisites

  • Node.js 18.0 or higher
  • npm or yarn
  • MongoDB account
  • AssemblyAI account for the API key

Installation and Setup

  1. Clone the repository
git clone https://github.com/ArshTiwari2004/Recap.git
cd Recap
cd Recap-frontend
  1. Install dependencies
npm install
# or
yarn install
  1. Set up environment variables
cp .env.example .env.local

Fill in your environment variables in .env.local:

ASSEMBLY_API_KEY=your_api_key
MONGODB_URI=your_mongodb_uri
...
  1. Run the development server
npm run dev
# or
yarn dev
  1. Open http://localhost:5173 in your browser

πŸ“– Documentation

For detailed documentation, please visit our Wiki.

πŸ‘₯ Team Synapse

Meet the minds behind Recap:

Arsh Tiwari

GitHub LinkedIn Twitter

Priyanshi Bothra

GitHub LinkedIn Twitter

Nibedan Pati

GitHub LinkedIn Twitter

🀝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

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

πŸ“„ License

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

πŸ“ž Contact

For support or queries, reach out to us at teamsynapse3@gmail.com


Made with ❀️ by Team Synapse