A sample Flask and PostgreSQL project designed for learning how to create a simple CRUD API using python. This project will be integrated into another repository for the frontend, serving the purpose of managing comics uploaded by users.
- Flask
- Flask Restx
- PostgreSQL
- Flask Mail
Before running the project, make sure to set up your environment variables in the .env file as follows:
POSTGRES_USER=root
POSTGRES_PASSWORD=root
POSTGRES_DB=root
POSTGRES_HOST_DB=db
PGADMIN_DEFAULT_EMAIL=[email protected]
PGADMIN_DEFAULT_PASSWORD=admin
MAIL_USERNAME={{your email}}
MAIL_PASSWORD={{your password from mail service}}
MAIL_SERVER={{your mail server}}
MAIL_PORT={{your mail port}}
MAIL_USE_SSL={{True or False}}
FLASK_DEBUG={{True or False}}
FLASK_ENV={{development or production}}
Use the following command to build and start the project:
# For development, you can run the dev.sh file
chmod +x ./dev.sh
./dev.sh
# Or using Docker compose directly
docker compose up --buildExplore the API documentation using Swagger at localhost:5000/cms-api/docs
Note: This project is still experimental, and there may be changes in the future during development.