Skip to content

Commit 7a491f0

Browse files
committed
📝 Update format of docs
1 parent b1a0aac commit 7a491f0

1 file changed

Lines changed: 27 additions & 27 deletions

File tree

README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -8,42 +8,42 @@ Generate a backend and frontend stack using Python, including interactive API do
88

99
## Features
1010

11-
* Full Docker integration (Docker based)
11+
* Full **Docker** integration (Docker based)
1212
* Docker Swarm Mode deployment
13-
* Docker Compose integration and optimization for local development
14-
* Production ready Python web server using Nginx and uWSGI
15-
* Python Flask backend with:
16-
* Flask-apispec: Swagger live documentation generation
17-
* Marshmallow: model and data serialization (convert model objects to JSON)
18-
* Webargs: parse, validate and document inputs to the endpoint / route
19-
* Secure password hashing by default
20-
* JWT token authentication
21-
* SQLAlchemy models (independent of Flask extensions, so they can be used with Celery workers directly)
13+
* **Docker Compose** integration and optimization for local development
14+
* **Production ready** Python web server using Nginx and uWSGI
15+
* Python **Flask** backend with:
16+
* **Flask-apispec**: Swagger live documentation generation
17+
* **Marshmallow**: model and data serialization (convert model objects to JSON)
18+
* **Webargs**: parse, validate and document inputs to the endpoint / route
19+
* **Secure password** hashing by default
20+
* **JWT token** authentication
21+
* **SQLAlchemy** models (independent of Flask extensions, so they can be used with Celery workers directly)
2222
* Basic starting models for users and groups (modify and remove as you need)
23-
* Alembic migrations
24-
* CORS (Cross Origin Resource Sharing)
25-
* 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)
26-
* 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)
27-
* Easy Python integration with Jupyter Kernels for remote or in-Docker development with extensions like Atom Hydrogen or Visual Studio Code Jupyter
23+
* **Alembic** migrations
24+
* **CORS** (Cross Origin Resource Sharing)
25+
* **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)
26+
* 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)
27+
* Easy Python integration with **Jupyter Kernels** for remote or in-Docker development with extensions like Atom Hydrogen or Visual Studio Code Jupyter
2828
* Vue frontend:
29-
* Generated with Vue CLI
29+
* Generated with **Vue CLI**
3030
* JWT Authentication handling
3131
* Login view
3232
* After login, main dashboard view
33-
* Vuex
34-
* Vue-router
35-
* Vuetify for beautiful material design components
36-
* TypeScript
37-
* Docker server based on Nginx (configured to play nicely with Vue-router)
33+
* **Vuex**
34+
* **Vue-router**
35+
* **Vuetify** for beautiful material design components
36+
* **TypeScript**
37+
* Docker server based on **Nginx** (configured to play nicely with Vue-router)
3838
* Docker multi-stage building, so you don't need to save or commit compiled code
3939
* Frontend tests ran at build time (can be disabled too)
4040
* 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
41-
* PGAdmin for PostgreSQL database, you can modify it to use PHPMyAdmin and MySQL easily
42-
* Swagger-UI for live interactive documentation
43-
* Flower for Celery jobs monitoring
44-
* 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
45-
* Traefik integration, including Let's Encrypt HTTPS certificates automatic generation
46-
* GitLab CI (continuous integration), including frontend and backend testing
41+
* **PGAdmin** for PostgreSQL database, you can modify it to use PHPMyAdmin and MySQL easily
42+
* **Swagger-UI** for live interactive documentation
43+
* **Flower** for Celery jobs monitoring
44+
* 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
45+
* Traefik integration, including Let's Encrypt **HTTPS** certificates automatic generation
46+
* **GitLab CI** (continuous integration), including frontend and backend testing
4747

4848
## How to use it
4949

0 commit comments

Comments
 (0)