From dceca9c1e5ceb19a3946d2b4a3a69bd9ad5f25ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?= Date: Wed, 15 Nov 2023 21:03:37 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20README=20with=20in=20co?= =?UTF-8?q?nstruction=20notice=20(#552)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9eb0416..4c96214 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,22 @@ # Full Stack FastAPI and PostgreSQL - Base Project Generator -[![Build Status](https://travis-ci.com/tiangolo/full-stack-fastapi-postgresql.svg?branch=master)](https://travis-ci.com/tiangolo/full-stack-fastapi-postgresql) +## 🚨 Warning: in (re) construction 😎 🏗️ + +This project is currently being restructured, don't use it right now, hold for a bit. + +In the next couple of months it will be ready. 😎 🚀 + +Some of the future new features and changes: + +* Upgrade to the latest FastAPI. +* Migration from SQLAlchemy to SQLModel. +* Upgrade to Pydantic v2. +* Refactor and simplification of most of the code, a lot of the complexity won't be necessary anymore. +* Migrate from Vue.js 2 to React with hooks and TypeScript. +* Move from Docker Swarm Model to Kubernetes. +* GitHub Actions for CI. + +--- Generate a backend and frontend stack using Python, including interactive API documentation.