Revised README

[Jibola]

Still WIP.

New README information added to walk new users through creating their first Django project.

• Old README information needs to be split into new markdown files appropriately
• New README may need to still be trimmed further
• Included a very simple getting started leveraging the steps from the djangoproject.com. Uses ForeignKey still. Will most likely change.

[timgraham]

I envisioned a README similar to Django's and moving most of the other content to docs/.

[aclark4life]

I envisioned a README with less than 50 lines 😄 The only reason to say more is if we're catering to a non-Django audience (which we are). But I wouldn't say it here, I would link to the quick start.

Django MongoDB Backend

Installation

Note

Django is a dependency of Django MongoDB Backend and will be installed along with Django MongoDB Backend.

pip install django-mongodb-backend

Usage

Create project

django-admin startproject mysite --template \
    https://github.com/mongodb-labs/django-mongodb-project/archive/refs/heads/5.0.x.zip

Run server

Note

MongoDB should be running locally before you start Django.

python manage.py runserver

Open Django

Now open http://127.0.0.1:8000!