Skip to content

Commit 5d94daa

Browse files
Update README.md
1 parent b60f9b8 commit 5d94daa

File tree

1 file changed

+87
-1
lines changed

1 file changed

+87
-1
lines changed

README.md

Lines changed: 87 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,88 @@
11
# CookieCutterD3V
2-
Custom Cookiecutter template
2+
3+
FullFeatuered CookieCutter template
4+
Supporting most of useful technologies
5+
6+
## Which technologies we used?
7+
### Prometheus
8+
This template uses prometheus for monitoring requests, models, etc.
9+
10+
### Multiple api frameworks
11+
This template uses multiple api frameworks like:
12+
1. Django rest framework
13+
2. Django grpc framework
14+
3. Graphene django
15+
And if the none of above choosed, it will use the basic html features
16+
17+
### Project documentions with sphinx
18+
This template uses sphinx for project documention. eg: development, production, about, todos and etc.
19+
20+
### Api documentions with drf_spectacular
21+
This template uses drf-spectacular for documenting apis
22+
23+
### more technologies
24+
This template support more technologies like:
25+
1. Celery
26+
2. Django Channels
27+
3. Django debug toolbar
28+
4. Pytest
29+
5. Persian django configuration
30+
6. Docker
31+
7. Jwt
32+
8. And more...
33+
34+
## How to use it ?
35+
36+
### Installing cookiecutter
37+
38+
At first, you should install cookiecutter on your operation system
39+
40+
As the cookiecutter docs explained you can install cookiecutter by using pip with the command below:
41+
42+
```python3 -m pip install --user cookiecutter```
43+
44+
### Get template by cookiecutter
45+
46+
Then you should pass my template to cookiecutter:
47+
48+
```cookiecutter https://github.com/MohammadD3veloper/CookieCutterD3V```
49+
50+
### Answering cookiecutter questions
51+
52+
Now answer cookiecutter questions as desired
53+
After answering questions, your project will be ready
54+
55+
### declaring Environment variable for Django debug:
56+
Cause of usage of the debug variable before env initialization, template needs the debug variable from environment and you can set it in linux os with the command below:
57+
58+
```export DJANGO_DEBUG=true```
59+
60+
The value of this variable can be true/false
61+
62+
### Running tests
63+
64+
This template has a sample test, for ensure it is working as well, you can run command below in the root of project:
65+
66+
```pytest```
67+
68+
### Running makemigrations & migrate
69+
70+
```python manage.py makemigrations```
71+
72+
```python manage.py migrate```
73+
74+
### Creating Superuser
75+
76+
```python manage.py createsuperuser```
77+
78+
It will ask you a username & password like the default django UserManager
79+
After fill the creation form, it will create the superuser and you can access the admin panel url or documentation url
80+
81+
82+
## thanks !
83+
Thank you of using this template
84+
If you like it. Just give a star
85+
86+
## License
87+
This template is under GPL3 License
88+
Designed with ❤️ by MohammadD3veloper

0 commit comments

Comments
 (0)