diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 294022a..7b801f0 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -29,7 +29,9 @@ jobs: poetry-version: 1.7.1 - run: poetry install - run: poetry run pytest - - uses: codecov/codecov-action@v3 + + - name: Upload Coverage + uses: codecov/codecov-action@v3 semantic-release: name: Semantic Release and Publish diff --git a/README.md b/README.md index e1c94ba..7b11c97 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,84 @@ -![](assets/logo.png) - - -## Features - -* Full **Docker** integration (Docker based). -* Docker Swarm Mode deployment. -* **Docker Compose** integration and optimization for local development. -* Python **FastAPI** backend: - * **Fast**: Very high performance, on par with **NodeJS** and **Go** (thanks to Starlette and Pydantic). - * **Intuitive**: Great editor support. Completion everywhere. Less time debugging. - * **Easy**: Designed to be easy to use and learn. Less time reading docs. - * **Short**: Minimize code duplication. Multiple features from each parameter declaration. - * **Robust**: Get production-ready code. With automatic interactive documentation. - * **Standards-based**: Based on (and fully compatible with) the open standards for APIs: OpenAPI and JSON Schema. - * **Many other features** including automatic validation, serialization, interactive documentation, authentication with OAuth2 JWT tokens, etc. +

+ Logo +

+ +

+ + License: MIT + + + codecov + + + CI + + + GitHub release + + Python + + Made with Supabase + +

+ +# ⚑SupaFast⚑ +___ +> supabase & fastapi crud template +## Roadmap 🫢 +___ +- [x] FastAPI backend + - [x] **standard** structure for **FastAPI** project + ```text + ── src + β”‚ └── app + β”‚ β”œβ”€β”€ api + β”‚ β”‚ β”œβ”€β”€ api_v1 + β”‚ β”‚ β”‚ β”œβ”€β”€ endpoints + β”‚ β”‚ β”‚ β”‚ β”œβ”€β”€ __init__.py + β”‚ β”‚ β”‚ β”‚ └── items.py + β”‚ β”‚ β”‚ β”œβ”€β”€ __init__.py + β”‚ β”‚ β”‚ └── api.py + β”‚ β”‚ β”œβ”€β”€ __init__.py + β”‚ β”‚ └── deps.py + β”‚ β”œβ”€β”€ core + β”‚ β”‚ β”œβ”€β”€ __init__.py + β”‚ β”‚ β”œβ”€β”€ config.py + β”‚ β”‚ └── events.py + β”‚ β”œβ”€β”€ crud + β”‚ β”‚ β”œβ”€β”€ __init__.py + β”‚ β”‚ β”œβ”€β”€ base.py + β”‚ β”‚ └── crud_item.py + β”‚ β”œβ”€β”€ schemas + β”‚ β”‚ β”œβ”€β”€ __init__.py + β”‚ β”‚ β”œβ”€β”€ auth.py + β”‚ β”‚ β”œβ”€β”€ base.py + β”‚ β”‚ β”œβ”€β”€ item.py + β”‚ β”‚ └── msg.py + β”‚ β”œβ”€β”€ services + β”‚ β”‚ └── __init__.py + β”‚ β”œβ”€β”€ utils + β”‚ β”‚ └── __init__.py + β”‚ β”œβ”€β”€ __init__.py + β”‚ └── main.py + ... + ``` + - [x] **auto-auth** by fastapi dependency with supabase-auth + - [x] Full coverage of **CRUD** operations and **api** tests + - [x] pytest integration +- [ ] Supabase integration + - [x] crud supabase-postgresql + - [ ] websocket with supabase-realtime + - [ ] curd supabase-storage + - [ ] supafunc integration +- [ ] deployment + - [ ] Full **Docker** integration (Docker based). ## How to use it - -## Release Notes - +___ +![](assets/usage.gif) +## Release Notes πŸ₯Έ +___ ### Latest Changes * ✨ Upgrade items router with new SQLModel models, simplified logic, and new FastAPI Annotated dependencies. PR [#560](https://github.com/tiangolo/full-stack-fastapi-postgresql/pull/560) by [@tiangolo](https://github.com/tiangolo). diff --git a/assets/usage.gif b/assets/usage.gif new file mode 100644 index 0000000..77b2bd4 Binary files /dev/null and b/assets/usage.gif differ diff --git a/assets/img.png b/img.png similarity index 100% rename from assets/img.png rename to img.png