📝 Update README.md

Author: tiangolo

README.md

@@ -1,49 +1,54 @@
-# Full Stack Flask and PostgreSQL - Base Project Generator
+# Full Stack FastAPI and PostgreSQL - Base Project Generator
 
-[![Build Status](https://travis-ci.org/tiangolo/full-stack.svg?branch=master)](https://travis-ci.org/tiangolo/full-stack)
+[![Build Status](https://travis-ci.org/tiangolo/full-stack-fastapi-postgresql.svg?branch=master)](https://travis-ci.org/tiangolo/full-stack-fastapi-postgresql)
 
 Generate a backend and frontend stack using Python, including interactive API documentation.
 
-[![Screenshot](screenshot.png)](https://github.com/tiangolo/full-stack)
+[![Screenshot](screenshot.png)](https://github.com/tiangolo/full-stack-fastapi-postgresql)
 
 ## Features
 
-* Full **Docker** integration (Docker based)
-* Docker Swarm Mode deployment
+* Full **Docker** integration (Docker based).
+* Docker Swarm Mode deployment.
 * **Docker Compose** integration and optimization for local development
-* **Production ready** Python web server using Nginx and uWSGI
-* Python **Flask** backend with:
-  * **Flask-apispec**: Swagger live documentation generation
-  * **Marshmallow**: model and data serialization (convert model objects to JSON)
-  * **Webargs**: parse, validate and document inputs to the endpoint / route
-  * **Secure password** hashing by default
-  * **JWT token** authentication
-  * **SQLAlchemy** models (independent of Flask extensions, so they can be used with Celery workers directly)
-  * Basic starting models for users and groups (modify and remove as you need)
-  * **Alembic** migrations
-  * **CORS** (Cross Origin Resource Sharing)
-* **Celery** worker that can import and use models and code from the rest of the backend selectively (you don't have to install the complete app in each worker)
-* REST backend tests based on **Pytest**, integrated with Docker, so you can test the full API interaction, independent on the database. As it runs in Docker, it can build a new data store from scratch each time (so you can use ElasticSearch, MongoDB, CouchDB, or whatever you want, and just test that the API works)
-* Easy Python integration with **Jupyter Kernels** for remote or in-Docker development with extensions like Atom Hydrogen or Visual Studio Code Jupyter
-* Vue frontend:
-  * Generated with **Vue CLI**
-  * JWT Authentication handling
-  * Login view
-  * After login, main dashboard view
-  * **Vuex**
-  * **Vue-router**
-  * **Vuetify** for beautiful material design components
-  * **TypeScript**
-  * Docker server based on **Nginx** (configured to play nicely with Vue-router)
-  * 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
-* **PGAdmin** for PostgreSQL database, you can modify it to use PHPMyAdmin and MySQL easily
-* **Swagger-UI** for live interactive documentation
-* **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
-* Traefik integration, including Let's Encrypt **HTTPS** certificates automatic generation
-* **GitLab CI** (continuous integration), including frontend and backend testing
+* **Production ready** Python web server using Uvicorn and Gunicorn.
+* Python **[FastAPI](https://github.com/tiangolo/fastapi)** backend:
+    * **Fast**: Very high performance, on par with **NodeJS** and **Go** (thanks to Starlette and Pydantic).
+    * **Intuitive**: Great editor support. <abbr title="also known as auto-complete, autocompletion, IntelliSense">Completion</abbr> 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: <a href="https://github.com/OAI/OpenAPI-Specification" target="_blank">OpenAPI</a> and <a href="http://json-schema.org/" target="_blank">JSON Schema</a>.
+    * [**Many other features**](https://github.com/tiangolo/fastapi) including automatic validation, serialization, interactive documentation, authentication with OAuth2 JWT tokens, etc.
+* **Secure password** hashing by default.
+* **JWT token** authentication.
+* **SQLAlchemy** models (independent of Flask extensions, so they can be used with Celery workers directly).
+* Basic starting models for users (modify and remove as you need).
+* **Alembic** migrations.
+* **CORS** (Cross Origin Resource Sharing).
+* **Celery** worker that can import and use models and code from the rest of the backend selectively (you don't have to install the complete app in each worker).
+* REST backend tests based on **Pytest**, integrated with Docker, so you can test the full API interaction, independent on the database. As it runs in Docker, it can build a new data store from scratch each time (so you can use ElasticSearch, MongoDB, CouchDB, or whatever you want, and just test that the API works).
+* Easy Python integration with **Jupyter Kernels** for remote or in-Docker development with extensions like Atom Hydrogen or Visual Studio Code Jupyter.
+* **Vue** frontend:
+    * Generated with Vue CLI.
+    * **JWT Authentication** handling.
+    * Login view.
+    * After login, main dashboard view.
+    * Main dashboard with user creation and edition.
+    * Self user edition.
+    * **Vuex**.
+    * **Vue-router**.
+    * **Vuetify** for beautiful material design components.
+    * **TypeScript**.
+    * Docker server based on **Nginx** (configured to play nicely with Vue-router).
+    * 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.
+* **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.
+* Traefik integration, including Let's Encrypt **HTTPS** certificates automatic generation.
+* GitLab **CI** (continuous integration), including frontend and backend testing.
 
 ## How to use it
 
@@ -84,6 +89,11 @@ The input variables, with their default values (some auto generated) are:
 * `first_superuser`: The first superuser generated, with it you will be able to create more users, etc. By default, based on the domain.
 * `first_superuser_password`: First superuser password. Use the method above to generate it.
 * `backend_cors_origins`: Origins (domains, more or less) that are enabled for CORS (Cross Origin Resource Sharing). This allows a frontend in one domain (e.g. `https://dashboard.example.com`) to communicate with this backend, that could be living in another domain (e.g. `https://api.example.com`). It can also be used to allow your local frontend (with a custom `hosts` domain mapping, as described in the project's `README.md`) that could be living in `http://dev.example.com:8080` to cummunicate with the backend at `https://stag.example.com`. Notice the `http` vs `https` and the `dev.` prefix for local development vs the "staging" `stag.` prefix. By default, it includes origins for production, staging and development, with ports commonly used during local development by several popular frontend frameworks (Vue with `:8080`, React, Angular).
+* `smtp_port`: Port to use to send emails via SMTP. By default `587`.
+* `smtp_host`: Host to use to send emails, it would be given by your email provider, like Mailgun, Sparkpost, etc.
+* `smtp_user`: The user to use in the SMTP connection. The value will be given by your email provider.
+* `smtp_password`: The password to be used in the SMTP connection. The value will be given by the email provider.
+* `smtp_emails_from_email`: The email account to use as the sender in the notification emails, it would be something like `[email protected]`.
 
 * `postgres_password`: Postgres database password. Use the method above to generate it. (You could easily modify it to use MySQL, MariaDB, etc).
 * `pgadmin_default_user`: PGAdmin default user, to log-in to the PGAdmin interface.
@@ -113,14 +123,6 @@ Please refer to <a href="https://dockerswarm.rocks" target="_blank">DockerSwarm.
 
 After using this generator, your new project (the directory created) will contain an extensive `README.md` with instructions for development, deployment, etc. You can pre-read [the project `README.md` template here too](./{{cookiecutter.project_slug}}/README.md).
 
-## History
-
-**Note about Angular**: a previous version of this project generated a basic default Angular frontend application, but without any view or interaction with the rest of the stack (the backend API). I recently switched to Vue for frontend and used it to created the basic frontend views for this project (that didn't exist before). If you are interested in keeping the Angular version, let me know in an issue, I can create an Angular version of the project (without the current default views), then you can integrate your Angular app with the basic `Dockerfile` and additional files.
-
-This project was based on [senseta-os/senseta-base-project](https://github.com/senseta-os/senseta-base-project).
-
-As [I was the only maintainer](https://github.com/tiangolo), I'm continuing the development in this fork (https://github.com/tiangolo/full-stack).
-
 ## License
 
 This project is licensed under the terms of the MIT license.