https://github.com/kevyder/flask_template
Flask template project with preconfigured tools
https://github.com/kevyder/flask_template
flask python
Last synced: 4 months ago
JSON representation
Flask template project with preconfigured tools
- Host: GitHub
- URL: https://github.com/kevyder/flask_template
- Owner: kevyder
- License: apache-2.0
- Created: 2023-10-13T00:02:51.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2026-03-04T00:33:57.000Z (4 months ago)
- Last Synced: 2026-03-04T05:25:37.662Z (4 months ago)
- Topics: flask, python
- Language: Dockerfile
- Homepage:
- Size: 544 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flask Template
A ready-to-use Flask project template with preconfigured development and testing tools.
## Features
- [Flask](https://flask.palletsprojects.com/) 3.1.2
- Dependency management with [uv](https://github.com/astral-sh/uv)
- Linting and formatting: [ruff](https://github.com/astral-sh/ruff)
- Pre-commit hooks configured
- Testing with [pytest](https://docs.pytest.org/) and [coverage](https://coverage.readthedocs.io/)
- Docker-ready
## Requirements
- Python 3.14.0
- [uv](https://github.com/astral-sh/uv) 0.9.11
- Docker (optional)
## Usage
### Install uv 0.9.11
```sh
pip install uv==0.9.11
```
### Install project dependencies
```sh
uv sync
```
### Run locally
```sh
flask run --host=0.0.0.0 --port=8080 --debug
```
Or simply:
```sh
python app.py
```
### Run with Docker
```sh
docker-compose up --build
```
The app will be available at [http://localhost:8080](http://localhost:8080).
## Testing
```sh
pytest
```
## Pre-commit
Install pre-commit hooks:
```sh
pre-commit install
```
## Project structure
```
.
├── app.py
├── Dockerfile
├── docker-compose.yml
├── pyproject.toml
├── uv.lock
├── README.md
├── tests/
└── ...
```
## License
This project is licensed under the Apache 2.0 License. See the [LICENSE](LICENSE) file for details.