Green

Green is a project based on FastAPI.

Installation and Setup

1. Install Docker and Docker Compose if they are not already installed on your system.

2. Clone the project repository:

git clone https://github.com/Djama1GIT/green.git
cd green

3. Configure the environment variables in the .env file (Not required if you don't plan on using mail functionality).

4. Start the project:

docker-compose up --build

User Interface

After starting the project, you can access the Swagger user interface at: http://localhost:8080/docs.
In Swagger, you can view the available endpoints and their parameters, and also make requests to the API.

A small example of API usage is also implemented:
Front-end home page: http://localhost/

Flower: http://localhost:5555/

Technologies Used

• Python - The programming language used for the project.
• REST - The architectural style for building distributed systems, used in the project to create the API.
• FastAPI - The Python framework used in the project to implement the REST API.
• Redis - An in-memory database used in the project for data caching and storing Celery tasks.
• Celery - A library used in the project for executing background tasks and processing long-running operations.
• Flower - A web interface used in the project to monitor the status of Celery tasks and track their execution.
• PostgreSQL - A relational database used in the project for data storage.
• SQLAlchemy - An Object-Relational Mapping (ORM) used in the project for working with the database.
• Alembic - A database migration library used in the project to update the database structure when data models change.
• Docker - A platform used in the project for creating, deploying, and managing containers, allowing the application to run in an isolated environment.