diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..064b0c6671902b9093e186332a0d2ab5f8fab395 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +### Clone the repository +git clone <repository link> +cd <repository> + +### Create a virtual environment to isolate our package dependencies locally +python3 -m venv env +source env/bin/activate # On Windows use `env\Scripts\activate` + +### Install Django, Django REST framework and neomodel into the virtual environment +~~~ +pip install django +~~~ + +~~~ +pip install djangorestframework +~~~ + +~~~ +pip install neomodel +~~~ + +### Django common command lines +~~~ +python manage.py makemigrations # When you make changes to your models, your database needs to understand how these changes might affect the database. This command automatically makes files that document these changes. +~~~ + +~~~ +python manage.py runserver # This command you'll probably run the most of all commands. It means to run a emulated server on your local computer. +~~~