EGGIT - Hatch the Habit of Learning Better

Welcome to EGGIT! This is a simple Flask web application designed to help users hatch the habit of learning better through personalized learning resources, scheduling, and user management. Built with SQLite as the database, this app includes basic user authentication and a clean interface for managing learning sessions.

Setup Instructions

1. Clone the repository

git clone https://github.com/yourusername/EGGIT.git
cd EGGIT

2. Setup Configuration

To configure the application, you need to set up the environment variables in a .env file. Follow these steps:

1. Rename the .env.sample File

   • In the project directory, you’ll find a file named .env.sample.
   • Rename it to .env.

   mv .env.sample .env

   This will create a new .env file that will be used by Flask to load environment variables.

2. Set Up Your Email Configuration (Optional)

   If you want to use email functionality (e.g., for notifications or password reset emails), configure the following:

   • EMAIL_ADDRESS: Enter your email address (e.g., a Gmail account).
   • EMAIL_PASSWORD: If you're using Gmail and have 2-Step Verification enabled, create an App Password instead of using your Gmail password.

3. Set up a virtual environment

If you haven't already created a virtual environment, do so:

python3 -m venv venv

4. Activate the virtual environment

• For macOS/Linux

  source venv/bin/activate

• For Windows (using Git Bash or WSL)

  source venv/Scripts/activate

• For Windows (using Command Prompt)

  venv\Scripts\activate.bat

• For Windows (using PowerShell)

  venv\Scripts\Activate.ps1

5. Install the dependencies

  pip install -r requirements.txt

6. Run the app

flask run

7. Deactivate the virtual environment (when done)

Once you’re done, simply deactivate the virtual environment:

deactivate