-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Create README.md * Update README.md * Update README.md
- Loading branch information
Showing
1 changed file
with
26 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Django MongoDB Project Template | ||
|
||
This is the starter template for the Django-MongoDB Backend. In order to use, with your version of `django-mongodb-backend` and `django`: | ||
|
||
* Find your Django version. To do so from the command line, make sure you have django installed and type: | ||
|
||
```bash | ||
django-admin --version | ||
>> 5.0 | ||
``` | ||
|
||
|
||
## Create the Django Project | ||
From your shell, run the following command to create a new Django project replacing the `{{ project_name }}` and `{{ version }}` sections. | ||
|
||
```bash | ||
django-admin startproject {{ project_name }} --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/{{ version }}.x.zip | ||
``` | ||
|
||
Below is an example: | ||
|
||
For a project name `5_0_exmaple` that runs on `django==5.0.*`: | ||
|
||
```bash | ||
django-admin startproject 5_0_example --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/5.0.x.zip | ||
``` |