Skip to content

Commit fb6d64e

Browse files
authored
Create README.md (#5)
* Create README.md * Update README.md * Update README.md
1 parent f3594fa commit fb6d64e

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Django MongoDB Project Template
2+
3+
This is the starter template for the Django-MongoDB Backend. In order to use, with your version of `django-mongodb-backend` and `django`:
4+
5+
* Find your Django version. To do so from the command line, make sure you have django installed and type:
6+
7+
```bash
8+
django-admin --version
9+
>> 5.0
10+
```
11+
12+
13+
## Create the Django Project
14+
From your shell, run the following command to create a new Django project replacing the `{{ project_name }}` and `{{ version }}` sections.
15+
16+
```bash
17+
django-admin startproject {{ project_name }} --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/{{ version }}.x.zip
18+
```
19+
20+
Below is an example:
21+
22+
For a project name `5_0_exmaple` that runs on `django==5.0.*`:
23+
24+
```bash
25+
django-admin startproject 5_0_example --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/5.0.x.zip
26+
```

0 commit comments

Comments
 (0)