🚨 DEPRECATION WARNING 🚨
As FastAPI and the equivalent project generators provide a much better solution to all the use cases this project was built for, all the future development will be done there.
If you are starting a new project from scratch, check the alternatives at the FastAPI docs: Project Generation.
You are still free to use this project, but it won't receive any new features, changes, or bug fixes.
Full Stack Flask Couchbase - project generator
Generate a backend and frontend stack using Python, including interactive API documentation.
If you are using this project (or Flask in general to create web APIs) you would probably benefit more from FastAPI.
You can use the equivalent sibling project generator based on FastAPI: https://github.com/tiangolo/full-stack-fastapi-couchbase. It also has more features than this one.
There is also a FastAPI project generator based on PostgreSQL instead of Couchbase: https://github.com/tiangolo/full-stack-fastapi-postgresql.
FastAPI was created from the learnings acquired while creating and using these project generators for Flask, with all the plug-ins and ideas.
- FastAPI (and its project generators), would give you about 800% (8x) the performance achievable with this one.
- Writing code in FastAPI is about 200% to 300% faster. Because you write a lot less code, it is designed for web APIs, and you have auto-complete everywhere.
- About 40% of the human (developer) induced errors can be reduced (FastAPI does a lot of the data validation, conversion and documentation for you).
- 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
- Basic starting functionality for users and roles (modify and remove as you need)
- CORS (Cross Origin Resource Sharing)
- Celery worker that can import and use code from the rest of the backend selectively (you don't have to install the complete app in each worker)
- NoSQL Couchbase database that supports direct synchronization via Couchbase Sync Gateway for offline-first applications.
- Full Text Search integrated, using Couchbase.
- 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, 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
- Email notifications for account creation and password recovery, compatible with:
- ...any other provider that can generate standard SMTP credentials.
- Vue frontend:
- Generated with Vue CLI
- JWT Authentication handling
- Login view
- After login, main dashboard view
- Vuetify for beautiful material design components
- 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
- 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
How to use it
Go to the directoy where you want to create your project and run:
pip install cookiecutter cookiecutter https://github.com/tiangolo/full-stack-flask-couchbase
You will be asked to provide passwords and secret keys for several components. Open another terminal and run:
openssl rand -hex 32 # Outputs something like: 99d3b1f01aa639e4a76f4fc281fc834747a543720ba4c8a8648ba755aef9be7f
Copy the contents and use that as password / secret key. And run that again to generate another secure key.
The generator (cookiecutter) will ask you for some data, you might want to have at hand before generating the project.
The input variables, with their default values (some auto generated) are:
project_name: The name of the project
project_slug: The development friendly name of the project. By default, based on the project name
domain_main: The domain in where to deploy the project for production (from the branch
production), used by the load balancer, backend, etc. By default, based on the project slug.
domain_staging: The domain in where to deploy while staging (before production) (from the branch
master). By default, based on the main domain.
docker_swarm_stack_name_main: The name of the stack while deploying to Docker in Swarm mode for production. By default, based on the domain.
docker_swarm_stack_name_staging: The name of the stack while deploying to Docker in Swarm mode for staging. By default, based on the domain.
secret_key: Backend server secret key. Use the method above to generate it.
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
hostsdomain mapping, as described in the project's
README.md) that could be living in
http://dev.example.com:8080to cummunicate with the backend at
https://stag.example.com. Notice 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).
couchbase_user: Couchbase main user to be used by the application (code). By default
couchbase_password: Password of the main user, for the backend code. Generate it with the method above.
couchbase_sync_gateway_cors: List of CORS origins that the Sync Gateway should allow to talk to directly. Similar to
couchbase_sync_gateway_user: User to be created for the Couchbase Sync Gateway. This is what allows synchronization using the CouchDB protocol, with Couchbase Lite in mobile apps and PouchDB in the web and hybrid mobile apps.
couchbase_sync_gateway_password: Couchbase Sync Gateway password. Generate it with the method above.
traefik_constraint_tag: The tag to be used by the internal Traefik load balancer (for example, to divide requests between backend and frontend) for production. Used to separate this stack from any other stack you might have. This should identify each stack in each environment (production, staging, etc).
traefik_constraint_tag_staging: The Traefik tag to be used while on staging.
traefik_public_network: This assumes you have another separate publicly facing Traefik at the server / cluster level. This is the network that main Traefik lives in.
traefik_public_constraint_tag: The tag that should be used by stack services that should communicate with the public.
flower_auth: Basic HTTP authentication for flower, in the form
user:password. By default: "
sentry_dsn: Key URL (DSN) of Sentry, for live error reporting. If you are not using it yet, you should, is open source. E.g.:
docker_image_prefix: Prefix to use for Docker image names. If you are using GitLab Docker registry it would be based on your code repository. E.g.:
docker_image_backend: Docker image name for the backend. By default, it will be based on your Docker image prefix, e.g.:
git.example.com/development-team/my-awesome-project/backend. And depending on your environment, a different tag will be appended (
branch). So, the final image names used will be like:
docker_image_celeryworker: Docker image for the celery worker. By default, based on your Docker image prefix.
docker_image_frontend: Docker image for the frontend. By default, based on your Docker image prefix.
docker_image_sync_gateway: Docker image for the Sync Gateway. By default, based on your Docker image prefix.
How to deploy
This stack can be adjusted and used with several deployment options that are compatible with Docker Compose, but it is designed to be used in a cluster controlled with pure Docker in Swarm Mode with a Traefik main load balancer proxy handling automatic HTTPS certificates, using the ideas from DockerSwarm.rocks.
Please refer to DockerSwarm.rocks to see how to deploy such a cluster in 20 minutes.
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.
This project is licensed under the terms of the MIT license.