Skip to content

Latest commit

Β 

History

18 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Exam_Simulator_v2.0 πŸŽ“

Welcome to the Exam Simulator App! This AI-powered desktop application leverages the Llama 8B model to provide an interactive and personalized exam experience. This is the second and most robust release, featuring login capabilities, student reviews, AI-generated papers, an AI teacher, and a dark mode calculator. Deployed on Render and powered by Flask, this app is your ultimate exam preparation tool.

πŸŽ‰ My project was reviewed by the incredible Krish Naik Sir! 🌟 Check out the review here: Video Link πŸš€ Grateful for this amazing opportunity! πŸ™

Features ✨

  • User Detail Collection πŸ“: Gather user details to generate customized exam papers.
  • AI-Generated Exam Papers πŸ“„: Custom papers generated based on the provided user details.
  • AI Teacher πŸ§‘β€πŸ«: Get answers to your queries and detailed performance reports.
  • Calculator with Dark Mode πŸ–€: Functional calculator that’s easy on the eyes.
  • Student Reviews πŸ’¬: Collect feedback to continuously improve the experience.

Project Structure πŸ“

Exam Simulator App/
β”‚
β”œβ”€β”€ AI_Service/
β”‚   └── llama.py
β”‚
β”œβ”€β”€ Backend/
β”‚   └── app.py
β”‚
β”œβ”€β”€ Frontend/
β”‚   └── static/
β”‚       β”œβ”€β”€ style.css
β”‚       β”œβ”€β”€ static.js
β”‚       └── images/
β”‚           └── different images files
β”‚   └── templates/
β”‚       β”œβ”€β”€ index.html
β”‚       β”œβ”€β”€ student.html
β”‚       └── application.html
β”œβ”€β”€ modules/
β”‚      β”œβ”€β”€ Extraction.py
β”œβ”€β”€ requirements.txt
└── .env

Installation πŸ› οΈ

Prerequisites

  • Python 3.7 or higher
  • Git
  • Virtual Environment (venv)
  • Groq API Key

Steps

  1. Clone the repository:

    git clone https://github.com/yourusername/exam-simulator-app.git
    cd exam-simulator-app
  2. Set up the environment:

    • Create a virtual environment:
      python -m venv venv
      venv\Scripts\activate  # On Windows 
    • Install the required packages:
      pip install -r requirements.txt
  3. Configure environment variables:

    • Create a .env file in the root directory and add your Groq API key:
      GROQ_API_KEY=your_groq_api_key
  4. Run the app:

    python app.py 

Deployment πŸš€

The app is deployed on Render. To deploy the app:

  1. Connect your GitHub repository to Render.
  2. Follow the Render deployment steps.
  3. Set the environment variables on Render with your Groq API key.

Usage πŸ“š

User Detail Collection

  • Enter Details: Provide your details such as name, subject, topic, and grade level. This information is used to generate a customized exam paper tailored to your needs.

Generate Exam Papers

  • Custom Exam Papers: Once you've entered your details, the AI generates an exam paper specifically for you. This includes questions from the topics you need to focus on, ensuring a targeted study session.
  • Review Questions: After completing the exam, review the questions and your answers.

AI Teacher Assistance

  • Ask Queries: Have any doubts or questions? Ask the AI teacher, who is always ready to help you understand the concepts better.
  • Performance Reports: Get detailed reports on your performance, highlighting areas of strength and topics that need improvement.

Calculator

  • Dark Mode: Use the built-in calculator with dark mode for all your calculation needs, ensuring comfort during long study hours.

Student Reviews

  • Feedback: Provide feedback on your experience, which helps us improve the app continuously.

Modules 🧩

  • AI_Service/llama.py: Handles interactions with the Llama 8B model.
  • Backend/app.py: Flask application managing backend logic and routing.
  • Frontend/static/: Contains all static assets like CSS, JS, and images.
  • Frontend/templates/: HTML templates for different pages.

Platform Compatibility πŸ–₯️

  • Desktop Application: This app is designed and recommended for use on desktop computers. It ensures a seamless experience with all the features functioning optimally.
  • Mobile Version: A mobile version is not currently supported. Future updates will include a mobile-friendly version along with bug fixes and performance enhancements.

Contributions 🀝

We welcome contributions from the community! Here’s how you can contribute:

  1. Fork the repository.
  2. Create a new branch:
    git checkout -b feature-branch
  3. Make your changes and commit them:
    git commit -m "Description of changes"
  4. Push to the branch:
    git push origin feature-branch
  5. Open a Pull Request: Describe your changes and submit the pull request.

License πŸ“œ

This project is licensed under the MIT License. See the LICENSE file for details.

Demo

exam-simulator_XnohLN26.mp4

Thank you for using the Exam Simulator App! If you have any questions or feedback, please reach out. Happy studying! πŸ“–βœ¨

About

πŸ’‘Welcome to the Exam Simulator App Version 2.0 ! This AI-powered desktop application leverages the Llama 8B model to provide an interactive and personalized exam experience.The App transforms exam preparation with personalized AI-generated papers and interactive AI teacher support. Built for desktop use, it ensures a targeted and engaging study

Resources

Stars

5 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages