- Python 3.9
- Ensure all required libraries are installed (refer to
requirements.txt)
-
Clone the Repository
git clone <repository_url> cd <repository_folder>
-
Create and Activate Virtual Environment (Optional but recommended)
- For Windows:
python -m venv venv .\venv\Scripts\activate
- For macOS/Linux:
python -m venv venv source venv/bin/activate
- For Windows:
-
Install Required Libraries
pip install -r requirements.txt
-
Configure the .env File
- Create a
.envfile in the root directory of the project (see.env.examplefile).
- Create a
-
Run the Flask Application
flask run
The application will be available at
http://127.0.0.1:5000/.
-
Initialize the Database
flask db init
-
Create Database Migrations
flask db migrate -m "migration message" -
Run Database Migrations
flask db upgrade
-
Run Tests
pytest