Skip to content

gurmeetgupta22/StudMaster

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

14 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸš€ StudMaster

StudMaster is an AI-powered practice test web application designed to help students prepare effectively for academic subjects and competitive examinations. It provides a clean, modern, and distraction-free interface with dynamically generated questions based on user input β€” no login or profile required.


✨ Features

  • 🧠 AI-Generated Practice Tests Questions are generated in real time using an AI model based on the topic and number of questions selected by the user.

  • πŸŽ“ Multiple Learning Domains

    • School (Classes 6–12)
    • College (Course, semester, topic-based)
    • Competitive Exams (JEE, NEET, CUET, etc.)
  • βš™οΈ Fully Dynamic No predefined questions. Every test is generated fresh using AI.

  • πŸ§ͺ Real Exam Interface

    • One question at a time
    • MCQ format with four options
    • Progress bar and timer
    • Exit Test button to return to home anytime
  • 🎨 Smooth UI & Animations Includes a fade-in animation when the site loads for a polished user experience.

  • πŸ”“ No Login Required Students can start practicing instantly without creating an account.


πŸ›  Tech Stack

Backend

  • FastAPI (Python)
  • OpenRouter API (AI question generation)
  • Environment-based configuration using .env

Frontend

  • HTML
  • CSS
  • Vanilla JavaScript

πŸ“ Project Structure

StudMaster/
β”‚
β”œβ”€β”€ backend/
β”‚   β”œβ”€β”€ app/
β”‚   β”‚   β”œβ”€β”€ ai_generator.py
β”‚   β”‚   β”œβ”€β”€ config.py
β”‚   β”‚   β”œβ”€β”€ main.py
β”‚   β”‚   β”œβ”€β”€ models.py
β”‚   β”‚   └── session_manager.py
β”‚   β”œβ”€β”€ .env.example
β”‚   β”œβ”€β”€ requirements.txt
β”‚
β”œβ”€β”€ docs/
β”‚   β”œβ”€β”€ index.html
β”‚   β”œβ”€β”€ style.css
β”‚   β”œβ”€β”€ test.html
β”‚   β”œβ”€β”€ test.js
β”‚   └── config.js
β”‚
└── .gitignore

βš™οΈ Setup Instructions

1️⃣ Clone the Repository

git clone https://github.com/your-username/StudMaster.git
cd StudMaster

2️⃣ Backend Setup

cd backend
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate
pip install -r requirements.txt

Create a .env file:

OPENROUTER_API_KEY=your_api_key_here
OPENROUTER_BASE_URL=https://openrouter.ai/api/v1
OPENROUTER_MODEL=deepseek/deepseek-chat
SESSION_EXPIRE_MINUTES=30

Run the backend:

uvicorn app.main:app --reload

3️⃣ Frontend Setup

Simply open docs/index.html in your browser.


πŸ“Œ Notes

  • This project is intended for educational purposes.
  • Ensure your OpenRouter API key has access to the selected model.
  • No user data is stored.

πŸ“œ License

This project is open-source and free to use.


⭐ If you like this project, consider giving it a star!

About

πŸš€ StudMaster-This web application is an AI powered practice test platform designed to help students prepare effectively for academic subjects and competitive examinations. The application opens directly on the learning interface with a smooth fade in animation, providing modern, clean and distraction free experience from the moment the site loads.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages