Create README.md #5
Merged
Conversation
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
aclark4life
reviewed
Jan 13, 2025
| @@ -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`: | |||
There was a problem hiding this comment.
"Django MongoDB Backend" or django-mongodb-backend probably
aclark4life
reviewed
Jan 13, 2025
|
|
||
| Below is an example: | ||
|
|
||
| For a project name `5_0_exmaple` that runs on `django==5.0.*`: |
There was a problem hiding this comment.
s/5_0_exmaple/5_0_example
aclark4life
reviewed
Jan 13, 2025
|
|
||
| ```bash | ||
| django-admin startproject 5_0_example --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/5.0.x.zip | ||
| ``` |
There was a problem hiding this comment.
We don't have any branches yet but in the meantime: https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/main.zip
aclark4life
reviewed
Jan 13, 2025
|
|
||
| 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: |
There was a problem hiding this comment.
NIT: Django or django
aclark4life
reviewed
Jan 13, 2025
| 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 |
There was a problem hiding this comment.
Probably would prefer django-admin startproject mysite --template https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/main.zip (or 5.0.x.zip if we create branches).
aclark4life
requested changes
Jan 13, 2025
aclark4life
added a commit
that referenced
this pull request
Jan 14, 2025
* Update migrations per ObjectIdAutoField.deconstruct() (#2) See mongodb-labs/django-mongodb-backend@a06efe3 * Use django_mongodb.parse_uri (#3) * Use django_mongodb.parse_uri * Update project_name/settings.py-tpl Co-authored-by: Jib <[email protected]> --------- Co-authored-by: Jib <[email protected]> * Rename (#4) * Rename (#6) * Create README.md (#5) * Create README.md * Update README.md * Update README.md --------- Co-authored-by: Tim Graham <[email protected]> Co-authored-by: Jib <[email protected]> Co-authored-by: Jib <[email protected]>
aclark4life
added a commit
that referenced
this pull request
Jan 14, 2025
* Update migrations per ObjectIdAutoField.deconstruct() (#2) See mongodb-labs/django-mongodb-backend@a06efe3 * Use django_mongodb.parse_uri (#3) * Use django_mongodb.parse_uri * Update project_name/settings.py-tpl Co-authored-by: Jib <[email protected]> --------- Co-authored-by: Jib <[email protected]> * Rename (#4) * Rename (#6) * Create README.md (#5) * Create README.md * Update README.md * Update README.md * Readme fixes (#8) --------- Co-authored-by: Tim Graham <[email protected]> Co-authored-by: Jib <[email protected]> Co-authored-by: Jib <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.