Skip to content

Add PyMongo, connection string, & Atlas "deploy a free cluster" links to README #436

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 1, 2025
Merged

Add PyMongo, connection string, & Atlas "deploy a free cluster" links to README #436

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Django MongoDB Backend

Django MongoDB Backend is a [Django]((https://docs.djangoproject.com/)
database backend that uses [PyMongo](https://www.mongodb.com/docs/languages/python/pymongo-driver/)
to connect to MongoDB.

## Documentation

Documentation written in the style of MongoDB's documentation is available at
Expand Down Expand Up @@ -39,7 +43,7 @@ django-admin --version
### Connect to the database

Navigate to your `example/settings.py` file and replace the `DATABASES`
setting like so:
setting using your [connection string](https://www.mongodb.com/docs/manual/reference/connection-string/):

```python
DATABASES = {
Expand All @@ -51,6 +55,10 @@ DATABASES = {
}
```

> [!TIP]
> You can quickly and easily [deploy a free cluster](https://www.mongodb.com/docs/atlas/tutorial/deploy-free-tier-cluster/)
> with MongoDB Atlas.

### Run the server

To verify that you correctly configured your project, run the following command
Expand Down