Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

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/CD

See 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