https://github.com/solnustec/flask-template
Template Flask Project
https://github.com/solnustec/flask-template
auto-deploy flask python template-project
Last synced: 4 days ago
JSON representation
Template Flask Project
- Host: GitHub
- URL: https://github.com/solnustec/flask-template
- Owner: solnustec
- Created: 2025-03-09T00:18:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-03-29T07:58:05.000Z (3 months ago)
- Last Synced: 2026-03-29T10:37:08.430Z (3 months ago)
- Topics: auto-deploy, flask, python, template-project
- Language: Python
- Homepage:
- Size: 37.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# @solnustec/flask-template
First, you need to change the project name in the following files:
- `sonar-project.properties`
- `app/config/settings.py`
- `local.yml`
- `README.md`
## Requirements
You need to install the following dependencies.
1. [Python](https://www.python.org/): the min version required is `3.10`
2. [Docker](https://docker.com): recommended in the latest version
3. [Git](https://git-scm.com/): recommended in the latest version
## Set-up
- Run `docker compose -f local.yml build` in the root directory. This going to install all
the required packages.
- Run `docker compose -f local.yml up` to start the server on port `8080`
- Enjoy! 😊
To configure the project, you must create an .env file by copying the provided `back.env` template:
```sh
cp back.env .env
```
Then, update the .env file with the following environment variables:
## Running Tests & Code Formatting
Common commands for development tasks are available in the `Makefile`. To run them, use:
```sh
make
```
### **Testing & Linting**
Commands for running tests and ensuring code quality.
- `make lint` → Format code using `black` and `isort`.
- `make lint-check` → Check code formatting without modifying files. Also runs `flake8` for linting.
### **Pre-Push Checks**
Ensure code quality and fix issues before pushing changes.
- `make pre-push-fix` → Auto-fix backend issues using predefined scripts.
- `make pre-push` → Run validation checks before pushing to GitHub.