Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alisayyah/fastapi-piccolo-template
A project template for FastAPI and Piccolo
https://github.com/alisayyah/fastapi-piccolo-template
fastapi fastapi-template piccolo project-template template
Last synced: 2 months ago
JSON representation
A project template for FastAPI and Piccolo
- Host: GitHub
- URL: https://github.com/alisayyah/fastapi-piccolo-template
- Owner: AliSayyah
- Created: 2022-01-16T19:51:14.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T01:50:40.000Z (2 months ago)
- Last Synced: 2024-10-28T05:44:19.810Z (2 months ago)
- Topics: fastapi, fastapi-template, piccolo, project-template, template
- Language: Python
- Homepage:
- Size: 155 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FastAPI-Piccolo project template
- Amazing [FastAPI](https://github.com/tiangolo/fastapi) framework.
- Full Docker integration
- Docker Compose integration and optimization for local development.
- JWT token authentication.
- Secure password hashing by default.
- [Piccolo Admin](https://github.com/piccolo-orm/piccolo_admin) frontend
- [Piccolo async ORM](https://github.com/piccolo-orm/piccolo)
- simple CI/CDSee each project's documentation for more information.
## Setup
### build the containers
```bash
docker-compose build
```
### run the server for local development```bash
docker-compose up
```### Running tests
```bash
docker-compose run web sh -c "pdm run test"
```## todo:
- [ ] add load balancer (Traefik)
- [ ] add caching mechanism
- [ ] add celery and flower for monitoring jobs
- [X] add pgadmin
- [ ] full CI/CD actions
- [ ] Gunicorn integration for single server mode
- [ ] Docker swarm integration + kubernetes for cluster mode
- [ ] CookieCutter