Skip to content

Commit

Permalink
Create README.md (#5)
Browse files Browse the repository at this point in the history
* Create README.md

* Update README.md

* Update README.md
  • Loading branch information
Jibola authored Jan 14, 2025
1 parent f3594fa commit fb6d64e
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
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
```

0 comments on commit fb6d64e

Please sign in to comment.