Skip to content

Latest commit

History

13 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

ExamNotes AI 🚀

ExamNotes AI Banner

ExamNotes AI is an intelligent, AI-powered platform designed to help students generate high-yield, exam-oriented notes, project documentation, flow diagrams, and revision materials in seconds. Whether you are preparing for Board Exams (CBSE), JEE, or NEET, ExamNotes AI structures your study material faster, cleaner, and smarter.

🌟 Features

  • Smart AI Notes Generation: Generate tailored notes based on topic, class/level, and exam type.
  • Visual Learning (Charts & Diagrams): Auto-generated Mermaid flowcharts and Recharts-based visual data to simplify complex topics.
  • Quick Revision Mode: Get quick, bite-sized revision points and priority topics.
  • PDF Download: Download clean, printable PDFs of your generated notes instantly.
  • Credit System: Secure integrated payment gateway (Razorpay) to purchase credits for generating more notes.
  • Modern UI/UX: A beautiful, responsive, and dark-themed user interface built with TailwindCSS and Framer Motion.

📸 Screenshots

1. Notes Generation Dashboard

Notes GeneratorGenerate targeted notes by entering your topic, class, and selecting the exam type along with options for diagrams and charts.

2. Comprehensive AI Notes

Generated NotesView structured notes with priority sub-topics, core concepts, syntax basics, and more.

3. Visual Charts & Flow Diagrams

Diagrams and ChartsAuto-generated flow diagrams and weightage charts to enhance visual memory and understanding.

4. Credit Purchase System

Buy CreditsFlexible plans for students to buy credits seamlessly via Razorpay integration.

🛠️ Tech Stack

Frontend:

  • React 19 (Vite)
  • TailwindCSS
  • Redux Toolkit (State Management)
  • Framer Motion (Animations)
  • Recharts (Data Visualization)
  • Mermaid.js (Flow Diagrams)
  • Firebase (Authentication)
  • React Markdown

Backend:

  • Node.js & Express.js
  • MongoDB (Mongoose)
  • Razorpay (Payment Gateway)
  • JSON Web Tokens (JWT Authentication)
  • PDFKit (PDF Generation)

🚀 Getting Started

Follow these steps to set up the project locally.

Prerequisites

  • Node.js installed on your machine.
  • MongoDB database connection URI.
  • Razorpay API Keys.
  • Firebase Project configuration.

1. Clone the repository

git clone <your-repo-url>cd ExamNotesAI

2. Setup Backend (Server)

cd server
npm install

Create a .env file in the server directory and add your environment variables:

PORT=5000MONGO_URI=your_mongodb_uriJWT_SECRET=your_jwt_secretRAZORPAY_KEY_ID=your_razorpay_keyRAZORPAY_SECRET=your_razorpay_secret

Run the server:

npm run dev

3. Setup Frontend (Client)

Open a new terminal window:

cd client
npm install

Create a .env file in the client directory and add your Firebase and API configurations (example):

VITE_API_URL=http://localhost:5000VITE_FIREBASE_API_KEY=your_api_keyVITE_FIREBASE_AUTH_DOMAIN=your_auth_domainVITE_FIREBASE_PROJECT_ID=your_project_idVITE_FIREBASE_STORAGE_BUCKET=your_storage_bucketVITE_FIREBASE_MESSAGING_SENDER_ID=your_messaging_sender_idVITE_FIREBASE_APP_ID=your_app_id

Run the frontend client:

npm run dev

📜 License

This project is licensed under the ISC License.

Releases

Packages

Contributors

Languages