https://github.com/nhymxu/flask-boilerplate
A boilerplate Flask RESTful API
https://github.com/nhymxu/flask-boilerplate
flask hacktoberfest poetry python
Last synced: 3 months ago
JSON representation
A boilerplate Flask RESTful API
- Host: GitHub
- URL: https://github.com/nhymxu/flask-boilerplate
- Owner: nhymxu
- Created: 2019-01-15T08:08:11.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-29T01:46:54.000Z (over 1 year ago)
- Last Synced: 2024-05-01T13:09:57.416Z (over 1 year ago)
- Topics: flask, hacktoberfest, poetry, python
- Language: Python
- Homepage:
- Size: 525 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - nhymxu/flask-boilerplate - A boilerplate Flask RESTful API (Python)
README
# flask-boilerplate
## Install
### for dev & test
```shell
uv sync --all-groups
```
### Production
```shell
uv sync --no-group dev
uv sync --no-group dev --group production
uv sync --group production
```
## Local run
```shell
flask --app web run
# or
FLASK_APP=web flask run
```
## Lint
```shell
ruff check .
```
## Deploy
synchronize: Gunicorn
async: Hypercorn/uvcorn
```shell
pip install "uvicorn[standard]" gunicorn
````
Note: on MacOS. Run this command to fix gunicorn error
```shell
export NO_PROXY=*
```
```shell
hypercorn web:asgi_app
uvicorn web:asgi_app --host 0.0.0.0 --port 80
gunicorn web:asgi_app --workers 4 --worker-class uvicorn.workers.UvicornWorker --bind 0.0.0.0:80
```