Skip to content

An AI-powered study platform that helps students organize, learn, and prepare efficiently through smart notes, quizzes, to-do tasks, and analytics — all powered by AI.

Notifications You must be signed in to change notification settings

richapatel28/Prepify---Smart-Study-Assistant

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 

Repository files navigation

🎓 Prepify – Smart Study Assistant

An AI-powered study platform that helps students organize, learn, and prepare efficiently through smart notes, quizzes, to-do tasks, and analytics — all powered by AI.


🧠 Overview

Prepify is an intelligent and modern web application that combines productivity with AI-driven learning.
It allows students to:

  • Take notes and organize them topic-wise
  • Manage their study schedules
  • Attempt quizzes
  • Generate flowcharts and 5-mark answers using Google Gemini AI
  • Track progress through an analytics dashboard

Prepify acts as your personal study companion, helping you learn smarter, stay consistent, and achieve your goals efficiently.


✨ Features

🎯 Core Modules

  • 📝 Notes Management – Create, view, and organize notes topic-wise.
  • 🧩 AI Flowchart Generator – Auto-generate process flowcharts from notes using Google Gemini AI.
  • 📋 To-Do Tasks with AI Answers – Create study questions, select multiple, and generate 5-mark answers instantly.
  • 📊 Analytics Dashboard – Track study progress, daily streaks, activity, and productivity.
  • 🎮 Quiz Section – Attempt quizzes by topic and view performance results.
  • ⚙️ User Settings – Update profile, email, and view streaks & account details.
  • 🤖 AI Chatbot – Interactive chat assistant for quick learning help.
  • 📱 Responsive UI – Works smoothly on desktop, tablet, and mobile.

🧩 Tech Stack

🖥️ Frontend

  • React.js (TypeScript) – Component-based UI framework
  • Tailwind CSS – Modern styling and responsiveness
  • Lucide Icons – Minimal vector icons
  • Axios / Fetch – API communication

⚙️ Backend

  • Node.js + Express.js – RESTful API and routing
  • MongoDB + Mongoose – Database for users, notes, quizzes, and todos
  • JWT Authentication – Secure login and sessions
  • Google Gemini API – AI answer and flowchart generation
  • Nodemailer – Email welcome and contact integration

🚀 Installation & Setup

Follow these steps to run Prepify – Smart Study Assistant locally.


🧰 Setup Backend

  1. Navigate to the backend folder:
    cd backend

2. Install dependencies:
   ```bash
   npm install
  1. Create a .env file inside backend/ and add:

    MONGO_URI=mongodb+srv://<username>:<password>@cluster0.mongodb.net/prepify
    JWT_SECRET=your_jwt_secret_key
    GEMINI_API_KEY=your_google_gemini_api_key
    PORT=5000

    Explanation:

    • MONGO_URI → MongoDB connection string (Atlas/local)
    • JWT_SECRET → Any random secret string for authentication
    • GEMINI_API_KEY → API key from Google AI Studio
    • PORT → Default backend port (5000)
  2. Start the backend server:

    npm start

    Or with Nodemon:

    npx nodemon index.js

    Expected Output:

    Server running on port 5000
    MongoDB connected successfully
    

💻 Setup Frontend (Client)

  1. Open a new terminal (keep backend running) and navigate to:

    cd ../smart-study
  2. Install dependencies:

    npm install
  3. Start the React development server:

    npm run dev
  4. Open your browser and visit:

    http://localhost:5173
    

    ✅ You should now see the Prepify Dashboard login screen.


🔑 Create Default User (Optional)

You can register a user directly via the app’s Register page. Alternatively, insert a test user in MongoDB:

{
  "name": "Aarmee Patel",
  "email": "aarmee@example.com",
  "password": "123456"
}

Then log in using that email and password.


🧠 Connecting Backend and Frontend

Your frontend connects by default to:

http://localhost:5000/api

If your backend runs on another port, update the base URL in:

smart-study/src/config.js

Example:

export const BASE_URL = "http://localhost:5000/api";

⚙️ Testing AI Features

To verify Google Gemini AI integration:

🧩 Flowchart Generator → Go to Notes Section → Add content → Click Generate Flowchart

📋 AI Answer Generator → Go to To-Do Section → Add questions → Select multiple → Click Generate Answers

If setup is correct, you’ll see AI-generated content on screen.


🧾 Folder Structure Summary

Prepify-Smart-Study-Assistant/
│
├── backend/                 # Express + MongoDB API
│   ├── controllers/         # API logic (notes, user, ai, etc.)
│   ├── routes/              # API endpoints
│   ├── models/              # MongoDB schemas
│   ├── middleware/          # JWT authentication
│   ├── services/            # Google Gemini AI integration
│   ├── index.js             # Server entry point
│   ├── .env                 # Environment variables
│
├── smart-study/             # React frontend
│   ├── src/
│   │   ├── components/      # UI pages (Notes, Todo, Quiz, etc.)
│   │   ├── App.tsx          # Main app entry
│   │   ├── router.tsx       # Route navigation
│   │   ├── index.css        # Styling
│   └── package.json         # Frontend dependencies
│
└── package.json             # Root config

🪄 Future Scope

  • 🤖 AI-based exam preparation suggestions
  • ⏱️ Study time tracking and focus timer
  • 👩‍🏫 Collaboration between students
  • 🎙️ Voice command-based assistant
  • 📅 Google Calendar integration for reminders

🏁 Conclusion

Prepify revolutionizes how students learn by combining technology, AI, and simplicity. It provides a unified platform to manage study routines efficiently — anytime, anywhere. 🌟


🪪 License

This project is licensed under the MIT License. You are free to use, modify, and distribute this project with attribution.

About

An AI-powered study platform that helps students organize, learn, and prepare efficiently through smart notes, quizzes, to-do tasks, and analytics — all powered by AI.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published