diff --git a/README.md b/README.md index e0d13a3816..f6ea504c89 100644 --- a/README.md +++ b/README.md @@ -8,17 +8,14 @@ Generate a backend and frontend stack using Python, including interactive API do [![API docs](img/docs.png)](https://github.com/tiangolo/full-stack-fastapi-postgresql) - ### Alternative API documentation [![API docs](img/redoc.png)](https://github.com/tiangolo/full-stack-fastapi-postgresql) - ### Dashboard Login [![API docs](img/login.png)](https://github.com/tiangolo/full-stack-fastapi-postgresql) - ### Dashboard - Create User [![API docs](img/dashboard.png)](https://github.com/tiangolo/full-stack-fastapi-postgresql) @@ -61,6 +58,7 @@ Generate a backend and frontend stack using Python, including interactive API do * Docker multi-stage building, so you don't need to save or commit compiled code. * Frontend tests ran at build time (can be disabled too). * Made as modular as possible, so it works out of the box, but you can re-generate with Vue CLI or create it as you need, and re-use what you want. + * It's also easy to remove it if you have an API-only app, check the instructions in the generated `README.md`. * **PGAdmin** for PostgreSQL database, you can modify it to use PHPMyAdmin and MySQL easily. * **Flower** for Celery jobs monitoring. * Load balancing between frontend and backend with **Traefik**, so you can have both under the same domain, separated by path, but served by different containers. diff --git a/{{cookiecutter.project_slug}}/README.md b/{{cookiecutter.project_slug}}/README.md index f1539db836..c0a2acf561 100644 --- a/{{cookiecutter.project_slug}}/README.md +++ b/{{cookiecutter.project_slug}}/README.md @@ -394,6 +394,26 @@ VUE_APP_ENV=development VUE_APP_ENV=staging ``` +### Removing the frontend + +If you are developing an API-only app and want to remove the frontend, you can do it easily: + +* Remove the `./frontend` directory. +* In the `docker-compose.yml` file, remove the whole service / section `frontend`. +* In the `docker-compose.override.yml` file, remove the whole service / section `frontend`. + +Done, you have a frontend-less (api-only) app. 🔥 🚀 + +--- + +If you want, you can also remove the `FRONTEND` environment variables from: + +* `.env` +* `.gitlab-ci.yml` +* `./scripts/*.sh` + +But it would be only to clean them up, leaving them won't really have any effect either way. + ## Deployment You can deploy the stack to a Docker Swarm mode cluster with a main Traefik proxy, set up using the ideas from DockerSwarm.rocks, to get automatic HTTPS certificates, etc.