This repository was archived by the owner on Oct 10, 2022. It is now read-only.
File tree Expand file tree Collapse file tree 1 file changed +50
-0
lines changed Expand file tree Collapse file tree 1 file changed +50
-0
lines changed Original file line number Diff line number Diff line change
1
+ # Fastapi-mvc cookiecutter
2
+
3
+ [ ![ CI] ( https://github.com/fastapi-mvc/cookiecutter/actions/workflows/main.yml/badge.svg )] ( https://github.com/fastapi-mvc/cookiecutter/actions/workflows/main.yml )
4
+ [ ![ Code style: black] ( https://img.shields.io/badge/code%20style-black-000000.svg )] ( https://github.com/psf/black )
5
+ ![ GitHub] ( https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10-blue )
6
+ ![ GitHub] ( https://img.shields.io/badge/license-MIT-blue )
7
+
8
+ ---
9
+
10
+ ** Example generated project** : [ fastapi-mvc/example] ( https://github.com/fastapi-mvc/example )
11
+
12
+ ---
13
+
14
+ Cookiecutter template used by [ fastapi-mvc/fastapi-mvc] ( https://github.com/fastapi-mvc/fastapi-mvc ) to generate a new project.
15
+
16
+ ## Features
17
+
18
+ * Generated project Based on MVC architectural pattern
19
+ * WSGI + ASGI production server
20
+ * Generated project comes with Sphinx documentation and 100% unit tests coverage
21
+ * Kubernetes deployment with Redis HA cluster
22
+ * Makefile, GitHub actions and utilities
23
+ * Helm chart for Kubernetes deployment
24
+ * Dockerfile with K8s and cloud in mind
25
+ * Generate pieces of code or even your own generators
26
+ * Reproducible development environment using Vagrant or Nix
27
+
28
+ ## Quickstart
29
+
30
+ To use this template outside ` fastapi-mvc ` :
31
+
32
+ 1 . Install cookiecutter
33
+ ``` shell
34
+ pip install -U cookiecutter
35
+ # Or use Nix
36
+ nix-shell shell.nix
37
+ ```
38
+
39
+ 2 . Generate new project:
40
+ ``` shell
41
+ cookiecutter https://github.com/fastapi-mvc/cookiecutter.git
42
+ ```
43
+
44
+ ## Contributing
45
+
46
+ TODO
47
+
48
+ ## License
49
+
50
+ [ MIT] ( https://github.com/fastapi-mvc/cookiecutter/blob/master/LICENSE )
You can’t perform that action at this time.
0 commit comments