GREBoost - Your Ultimate GRE Learning Platform ⚡️🏃🏻💨💨

🤯 Stressed out with GRE preparation? Use GREBoost to take control of your study strategy! 😵‍💫

GREBoost is a comprehensive e-learning management system designed to simplify and supercharge your GRE prep. With interactive flashcards, realistic practice tests, timely course announcements, and intuitive progress tracking, GREBoost has everything you need to study smarter, not harder—all in one easy-to-use platform.

Contents

• Product Overview
  
• Purpose and Motivation
  
• Key Features
  
• Tech Stack
  
• How to Run the Project
  
• How to Use GREBoost
  

Product Overview 🚀

GREBoost is a comprehensive e-learning management system designed to help students prepare effectively for the GRE exam. It offers a variety of features, including interactive flashcards for memorization, practice tests for skill assessment, course announcements, and user progress tracking—all wrapped in an intuitive and easy-to-use platform.

Purpose and Motivation 🎯

The GRE is a challenging exam that requires a strategic approach to studying. GREBoost was developed to address the difficulties students face when preparing for standardized tests, such as time management and consistent practice. Our goal is to provide an all-in-one solution to make GRE preparation efficient and less stressful.

Key Features 🏆

User Authentication: Secure login and signup with JWT-based authentication.

Course Management: View and enroll in courses. Access detailed course content tailored for the GRE.

Flashcards: Create and study flashcards to reinforce GRE concepts. Flip cards to reveal answers and mark progress!

Practice Tests & Quiz: Take practice tests and get immediate feedback. Track test attempts, scores, and duration.

Announcements: Stay informed about the latest updates, study material, and live Q&A sessions.

Tech Stack 🛠️

Backend: Flask, Flask-JWT-Extended for secure authentication

Database: MongoDB for robust data management

Frontend: Angular

Authentication: JWT for secure and reliable user authentication

Deployment: Deployed on Heroku

Data Handling: Bcrypt for password hashing

How to Run the Project 💡

Follow these steps to set up and run GREBoost locally:

You need to clone (download) the repository to your local machine using the below command in the terminal

   $ git clone https://github.com/sandeepkumar1709/GREBoost.git

This makes a local copy of the repository in your machine

Once you have cloned the GREBoost repository in Github, move to that folder first using the change directory cd command on Linux/ Mac/ Windows

   $ cd GREBoost

Then open the terminal inside GREBoost folder and run the following command

   $ code .

The above command opens the project folder in Visual Studio Code which will be the IDE for the GREBoost Development (Feel free to use the IDE of your choice)

Once you have downloaded the source code of GREBoost in your local machine, make sure npm and node are installed on your machine, then follow the below processes to start the GREBoost application in your development environment.

Steps to Set Up and Run the Angular Frontend

Navigate to the Project Folder Make sure you are in the root directory of GREBoost in your terminal. Use:

   cd GREBOOST

Install Dependencies Run the following command to install all the necessary dependencies listed in your package.json file:

   npm install

This will install everything needed for your Angular frontend, including Angular itself, Tailwind CSS (as indicated by tailwind.config.js), and any other dependencies.

Start the Angular Development Server Start the frontend application with:

   npm run start

This will compile the Angular project and launch a development server, typically available at http://localhost:4200. Your browser should open automatically, or you can manually visit this URL to see the frontend of GREBoost.

Set Up and run the backend

Navigate to the Backend Folder which happens to be in a directory named api, first navigate to that folder:

   cd GREBOOST/api

Create and Activate a Virtual Environment to manage dependencies. (On Windows)

   python -m venv venv
   venv\Scripts\activate

On MacOS/Linux

  python3 -m venv venv
source venv/bin/activate

Install Backend Dependencies Use pip to install the dependencies listed in requirements.txt

   pip install -r requirements.txt

Configure Environment Variables Create a .env file in the api folder (if it doesn’t already exist) and add the necessary environment variables. For example:

MONGO_URI=your-mongodb-uri
JWT_SECRET_KEY=your-jwt-secret-key

Replace your-mongodb-uri with the actual URI of your MongoDB database and your-jwt-secret-key with a secure secret key for JWT authentication.

Start the Flask Backend Server Use Flask to run the backend server:

flask run

This should start the backend server, typically running on http://localhost:5000.

How to Use GREBoost 📚

Sign Up: Create an account and log in.

Enroll in a Course: Browse available courses and enroll.

Study Using Flashcards: Use flashcards to memorize key concepts.

Take Practice Tests: Track your performance and identify areas for improvement.

View Announcements: Stay updated with new study material and live sessions.

deploy1