https://github.com/ArshTiwari2004/Recap
Your AI-powered smart companion for smarter learning
https://github.com/ArshTiwari2004/Recap
assemblyai cohere-ai firebase firebase-auth firestore nodejs ocr-recognition reactjs shadcn speechtotext tailwindcss vercel-deployment
Last synced: 26 days ago
JSON representation
Your AI-powered smart companion for smarter learning
- Host: GitHub
- URL: https://github.com/ArshTiwari2004/Recap
- Owner: ArshTiwari2004
- Created: 2025-01-05T11:15:45.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-08-25T08:22:22.000Z (about 2 months ago)
- Last Synced: 2025-08-25T10:55:46.478Z (about 2 months ago)
- Topics: assemblyai, cohere-ai, firebase, firebase-auth, firestore, nodejs, ocr-recognition, reactjs, shadcn, speechtotext, tailwindcss, vercel-deployment
- Language: JavaScript
- Homepage: https://recap-5ajg.vercel.app/
- Size: 18 MB
- Stars: 5
- Watchers: 0
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
> AI-powered note organization that adapts to your learning style. Capture, connect, and master your study materials effortlessly.
[](https://github.com/ArshTiwari2004/Recap/issues)
[](https://github.com/ArshTiwari2004/Recap/network)
[](https://github.com/ArshTiwari2004/Recap/stargazers)
[](https://github.com/ArshTiwari2004/Recap/graphs/contributors)
[](LICENSE)
## 📌 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
## Integrating Groq for Advanced AI Capabilities
Groq is revolutionizing AI inference by providing ultra-fast, energy-efficient solutions tailored for deploying and running AI models. Founded in 2016, Groq anticipated the industry's shift towards AI inference and has developed the Groq Language Processing Unit (LPU) to meet these demands. Unlike traditional GPUs designed for graphics processing, the LPU is purpose-built for AI tasks, delivering unparalleled speed and efficiency.
## Leveraging Groq in Our Project
In our project, Groq's technology is seamlessly integrated across multiple features to enhance performance and user experience:
### 🚀 AI-Powered Chatbot
Utilizing Groq's API, our chatbot offers real-time, accurate responses, effectively addressing user queries and providing instant assistance.
### 📚 Previous Year Question (PYQ) Generator and Analysis
Groq's API facilitates the generation of relevant questions and provides detailed analysis of student responses. This includes scoring, identifying mistakes, and directing students to pertinent resources, thereby enriching their learning journey.
### 📝 Smart Test Feature
Groq's capabilities enable the creation of customized tests based on user-defined parameters such as duration, subject, difficulty level, and class. The system generates questions, evaluates answers, ranks performance, and delivers precise results, all powered by Groq's advanced AI inference.
## 🖼️ Snippets
*Landing page of Recap*
*Dashboard of RECAP*
*AI-Generated Flashcards in RECAP*
## 🛠️ Tech Stack
### Frontend
|  |  |  |  |  |
|---|---|---|---|---|
### Backend
|  |  |  |  |  |
|---|---|---|---|---|
|  |  |  |  | |
### API Used
|  |  |
|---|---|
### DevOps & Deployment
|  |  |  |  |
|---|---|---|---|
## Architecture of RECAP
## 🚀 Getting Started
### Prerequisites
- Node.js 18.0 or higher
- npm or yarn
- Firebase account
- AssemblyAI account for the API key
- Groq API key
### Installation and Setup
1. Clone the repository
```bash
git clone https://github.com/ArshTiwari2004/Recap.git
```
```bash
cd Recap
```
```bash
cd Recap-frontend
```
2. Install dependencies
```bash
npm install
# or
yarn install
```
3. Set up environment variables
```bash
cp .env.example .env.local
```
Fill in your environment variables in `.env.local`:
```
VITE_FIREBASE_API_KEY=your_firebase_api_key
VITE_FIREBASE_AUTH_DOMAIN=your_firebase_auth_domain
VITE_FIREBASE_PROJECT_ID=your_firebase_project_id
VITE_FIREBASE_STORAGE_BUCKET=your_firebase_storage_bucket
VITE_FIREBASE_MESSAGING_SENDER_ID=your_firebase_messaging_sender_id
VITE_FIREBASE_APP_ID=your_firebase_app_id
VITE_ASSEMBLYAI_API_KEY=your_assemblyai_api_key
VITE_GROQ_API_KEY=your_groq_api_key
```
4. Run the development server
```bash
npm run dev
# or
yarn dev
```
5. Open [http://localhost:5173](http://localhost:5173) in your browser
## Technical Implementation Details for Groq
To integrate Groq's API into our project, follow these steps:
### 1️⃣ Obtain a Groq API Key
Sign up on the [Groq Developer Console](https://groq.com/) to receive your API key.
### 2️⃣ Set Up Environment Variables
In your `.env.local` file, include the following variables:
```env
VITE_GROQ_API_KEY=your_groq_api_key
```
### 3️⃣ In your project directory, install the official Groq client:
```env
npm i groq-sdk
```
## 📖 Documentation
For detailed documentation, please visit our [Wiki](https://github.com/ArshTiwari2004/Recap/wiki).
## 👥 Team Synapse
Meet the minds behind Recap:
### Arsh Tiwari
[](https://github.com/ArshTiwari2004)
[]([https://www.linkedin.com/in/arsh-tiwari-072609284/)
[]([https://x.com/ArshTiwari17)
### Priyanshi Bothra
[](https://github.com/priyanshi0609)
[](your-linkedin-url)
[](your-twitter-url)
### Nibedan Pati
[](https://github.com/Heisenberg300604)
[](your-linkedin-url)
[](your-twitter-url)
## 🤝 Contributing
We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) 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](LICENSE) file for details.
## 📞 Contact
For support or queries, reach out to us at [teamsynapse3@gmail.com](teamsynapse3@gmail.com)
---
Made with ❤️ by Team Synapse