This repository is a Python skeleton with Flask & PostgreSQL designed for quickly getting started developing an API. Check the Getting Started for full details.
Within the Makefile you can handle the entire flow to get everything up & running:
- Install
makeon your computer, if you do not already have it. - Build the Docker image:
make build - Migrate any DB pending task:
make migrate - Start the application:
make up
As you could see on the Makefile script, you could just avoid those steps and just execute make up, as
build and migrate are dependants of it.
Go to http://127.0.0.1:5050/ping to see that everything is up & running!
This skeleton is split into two main folders:
This folder contains the main Flask configuration. You will find there the core files to get the API up&running with the basic Flask settings parameters.
If you want to tweak or change anything of the configuration, this is the place!
Here you will find the different files to expose your URLs & endpoints, but also some folders to start coding and organize your code around a Clean Architecture.
You can use this as a starting point to continue with this architecture, or adapt it to your preferences.
If you are having problems or need anything else, please let us know by raising a new issue.
This project is licensed with the MIT license.
Made with ❤️ by Rviewer