NoteSavvy AI 🧠

Your personal AI tutor, note-maker, and exam mentor—all in one platform.

✨ Features

• 🤖 AI Subject Tutors: 24/7 access to specialized AI tutors for different subjects
• 📝 Smart Notes Creator: Generate customized notes in multiple formats (summaries, bullet points, flashcards)
• 📚 PYQ Repository: Searchable database of previous year questions with detailed solutions
• 👥 Study Rooms: Collaborate with peers in virtual study rooms with shared AI assistance
• 🌙 Dark Mode: Full dark/light mode support
• 📱 Responsive Design: Works seamlessly on desktop, tablet, and mobile

🛠️ Tech Stack

• Framework: Next.js 15 with App Router
• Language: TypeScript
• Styling: Tailwind CSS
• UI Components: shadcn/ui
• Icons: Lucide React

🚀 Getting Started

1. Clone the repository:

git clone https://github.com/yourusername/notesavvy.git
cd notesavvy

2. Install dependencies:

npm install
# or
yarn install

3. Copy environment variables:

cp .env.example .env.local

4. Start the development server:

npm run dev
# or
yarn dev

5. Open http://localhost:3000 in your browser.

📝 Environment Variables

Create a .env.local file in the root directory and add the following variables:

NEXT_PUBLIC_API_KEY=your_api_key_here
NEXT_PUBLIC_FIREBASE_CONFIG=your_firebase_config_here
NEXT_PUBLIC_OPENAI_API_KEY=your_openai_key_here

🏗️ Project Structure

notesavvy/
├── src/
│   ├── app/           # Next.js app directory
│   ├── components/    # Reusable React components
│   └── lib/           # Utility functions and types
├── public/           # Static assets
├── .env.example      # Example environment variables
└── package.json      # Project dependencies

📝 Contributing

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.

• Animations: Framer Motion
• State Management: React Context/Hooks

🚀 Getting Started

1. Clone the repository

   git clone <repository-url>
   cd notesavvy

2. Install dependencies

   npm install

3. Start the development server

   npm run dev

4. Open your browser Navigate to http://localhost:3000

📁 Project Structure

src/
├── app/                    # Next.js app router pages
│   ├── dashboard/         # Main dashboard
│   ├── chatbots/         # AI tutors interface
│   ├── notes/            # Notes creator
│   ├── pyq/              # PYQ repository
│   ├── studyroom/        # Study rooms
│   └── settings/         # User settings
├── components/            # Reusable components
│   ├── ui/               # shadcn/ui components
│   ├── layout/           # Layout components
│   └── features/         # Feature-specific components
├── lib/                  # Utility functions
├── types/                # TypeScript type definitions
└── utils/                # Helper utilities

🎨 Design System

• Primary Color: #4F46E5 (Indigo)
• Accent Color: #22D3EE (Cyan)
• Highlight Color: #FACC15 (Yellow)
• Typography: Clean, readable fonts with proper hierarchy
• Layout: Sidebar navigation + Top navbar + Main content

📱 Pages Overview

1. Landing Page (/) - Marketing page with features and pricing
2. Dashboard (/dashboard) - Main user dashboard with stats and quick actions
3. AI Tutors (/chatbots) - Chat interface with subject-specific AI tutors
4. Notes Creator (/notes) - AI-powered note generation tool
5. PYQ Repository (/pyq) - Browse and practice previous year questions
6. Study Rooms (/studyroom) - Collaborative study spaces
7. Settings (/settings) - User preferences and account settings

🔧 Available Scripts

• npm run dev - Start development server
• npm run build - Build for production
• npm run start - Start production server
• npm run lint - Run ESLint

🌟 Key Features Implementation

AI Tutors

• Subject-specific chat interfaces
• Contextual AI responses
• Message history and favorites
• Suggested prompts

Notes Creator

• Multiple output formats
• AI-powered generation
• Export to PDF/Markdown
• Save and organize notes

PYQ Repository

• Advanced search and filters
• Step-by-step solutions
• Difficulty levels
• Progress tracking

Study Dashboard

• Learning analytics
• Progress visualization
• Study recommendations
• Activity tracking

🎯 Future Enhancements

• User authentication and profiles
• Real-time collaboration
• Voice chat in study rooms
• Spaced repetition system
• Mobile app
• Offline mode
• Integration with popular learning platforms

🤝 Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Submit a pull request

📄 License

This project is licensed under the MIT License.

---

Built with ❤️ for students worldwide