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.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+# β‘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