Flask Application

This is a Flask-based web application with a structured project layout. The application includes API endpoints, database models, and various utilities to support its functionality.

Table of Contents

• Flask Application
  • Table of Contents
  • Installation
  • Configuration
  • Usage

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/your-repo.git
   cd your-repo

2. Create and activate a virtual environment:

   python -m venv venv
   source venv/bin/activate  # On Windows use `venv\Scripts\activate`

3. Install the dependencies:

   pip install -r requirements.txt

4. Set up the environment variables:

   Create a .env file in the root directory and add the necessary environment variables. Refer to the Config class in config.py for required variables.

   FLASK_ENV=development
   SECRET_KEY=your_secret_key
   DATABASE_URI=your_database_uri

5. Run the database migrations:

   flask db upgrade

Configuration

The application configuration is managed through the Config class. Environment variables are loaded from a .env file using python-dotenv.

Usage

1. Run the application:

   flask run

2. Access the application:

   Open your web browser and navigate to http://127.0.0.1:5000.