🚀 Aqua AI Flask Boilerplate

📖 Overview

This repository provides a boilerplate setup for a Flask application with a modular architecture.

📂 Folder Structure

• project-root/: Root directory of the project.
  • .venv/: Virtual environment.
  • requirements.txt: Project dependencies.
  • src/: Application source code.
  • ai/: AI Stuffs.
    • algorithms/: Predict and training algorithms
    • models/: Pkl models generated by algorithms
    • results/: json files represent the results of training
  • controllers/: All Flask blueprints (grouped route logic).
  • data/: Uploaded data from user (.CSV files).
  • datatypes/: TypedDicts, ApiResponse classes, shared data types.
  • models/: MongoDB schemas and data models.
  • routes/: Express-style route definitions.
  • services/: Database and business logic services.
  • static/: Static serving files (in need for css and js).
  • templates/: Rendered views (Views).
  • utils/: Common helper functions.
  • .env: Environment variables.
  • app.py: Registers blueprints , loads environment variables , initializes DB and runs the app server.

---

⚙️ Installation

1. Create a virtual environment

   python -m venv .venv

2. Install dependencies

   pip install -r requirements.txt

3. Install dependencies (Choose the .venv interpreter from your IDE panel.)

Firstly :

Secondly :

4. Run the app

   flask run

5. Access homepage

🌟 Best Wishes

May this project be the foundation of a strong and collaborative development journey 🔥.