https://github.com/gabrielroot/flask_starter_app
A repository with basic config to start coding with flask
https://github.com/gabrielroot/flask_starter_app
docker docker-compose flask postgresql
Last synced: 2 months ago
JSON representation
A repository with basic config to start coding with flask
- Host: GitHub
- URL: https://github.com/gabrielroot/flask_starter_app
- Owner: gabrielroot
- Created: 2022-12-11T00:53:48.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-10-22T02:06:44.000Z (8 months ago)
- Last Synced: 2025-10-22T04:10:27.016Z (8 months ago)
- Topics: docker, docker-compose, flask, postgresql
- Language: Python
- Homepage:
- Size: 250 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Flask starter App 🚀
###
About ptoject
###
The purpose of this project is to provide a basic starter for beginners when starting coding with flask. In my opinion, the
flask microframework setup is more difficult than other stacks available like Symfony, Node, React.js... So I decided
to make my life and other people's life easier with this.
###
### Techs
- Flask
- Flask==2.2.0
- Flask-SQLAlchemy==3.0.2
- Flask-Migrate==4.0.0
- PostgreSql
- Docker
- Dockerfile
- docker-compose
###
Made with
###
---
## Run: Step by Step ▶️
> *NOTE: What do you really need in your physical machine?*
> - [Docker](https://docs.docker.com/get-docker/)
> - [Docker Compose](https://docker-docs.netlify.app/compose/install/#install-compose)
> ### **O N L Y**
- `git clone https://github.com/gabrielroot/flask_starter_app.git`
- Navigate to project root directory
- Create a `.env` file based on `.env.sample`
- `docker-compose up -d`
- Wait for downloading images, libraries and setup
- Well done!
## Commands
> *In the root directory of the App:*
- `docker-compose up -d`, to start the app in background;
- `docker-compose down`, to stop the app;
- `docker attach [APP_NAME|ID]`, to start monitoring a container;
- `docker exec -it [CONTAINER] [COMMAND]`, to run a command in a container.
#### Migrations
> *Run the following lines when needs to manage migrations:*
- `docker exec -it main_flask flask db init`, to create a folder with set to migration;
- `docker exec -it main_flask flask db migrate -m "Initial migration."`, to generate a migration;
- `docker exec -it main_flask flask db [upgrade|downgrade]`, to up/down changes based on migration files.
## Urls
> *Accessible when the environment is running:*
- [App Flask - http://localhost:8000/](http://localhost:8000/)
- [Adminer - http://localhost:8080/](http://localhost:8080/)
## Tips ✨
- Start the app in non background mode (Or attach them when already running), so you can see the log of error and print outputs!