updated the readme and db default name

Author: Emile Frey

README.md

@@ -1,4 +1,30 @@
-**To-do:**
+# django-react-postgres-boilerplate
+
+## Prerequisites
+Install Docker Desktop
+
+## Installation
+
+There are 3 .env files provided. Note in particular the .env files in backend/ and postgres/; there, you can adjust the database credentials, debug mode, secret key, allowed hosts, etc. But things should run just fine without any changes, but just know these files are there.
+
+For development mode without NGINX server, run the following command:
+
+```sh
+docker-compose -f "docker-compose.dev.yml" up -d --build
+```
+The react frontend should be available at `http://localhost:3000/` and django backend at `http://localhost:8000/` (django admin at `http://localhost:8000/admin/`). This mode supports both react hot reloading and django auto-refresh with changes.
+
+For development with the NGINX server run:
+```sh
+docker-compose -f "docker-compose.yml" up -d --build
+```
+The server should be available at `http://127.0.0.1/`. This mode will not hot reload since it's running a production build.
+
+The included sample prediction django app can be easily removed by removing 'prediction' from INSTALLED_APPS in django mainapp/settings.py, removing the associated path in mainapp/urls.py and deleting the entire prediction folder.
+
+**_NOTE: This repo is still largely a work in progress, but it should be a good starting point. Suggestions/feedback are greatly appreciated._**
+
+**TODO:**
 - [ ] Basic Backend Testing
 - [ ] Frontend Testing (React Testing Library)
 - [ ] Readme (setup and how to remove remnants of dummy stuff)

backend/.env

@@ -10,7 +10,7 @@ DJANGO_ADMIN_PASSWORD=admin_password
 DATABASE=postgres
 
 DB_ENGINE=django.db.backends.postgresql
-DB_DATABASE=predictiondb
+DB_DATABASE=boilerplatedb
 DB_USER=postgres_user
 DB_PASSWORD=postgres_password
 DB_HOST=db

backend/mainapp/local_settings.py

@@ -46,7 +46,7 @@
     DATABASES = {
         'default': {
             'ENGINE': 'django.db.backends.postgresql_psycopg2',
-            'NAME': 'predictiondb',
+            'NAME': 'boilerplatedb',
             'USER': 'postgres_user',
             'PASSWORD': 'postgres_password',
             'HOST': '127.0.0.1',

postgres/.env

@@ -1,3 +1,3 @@
 POSTGRES_USER=postgres_user
 POSTGRES_PASSWORD=postgres_password
-POSTGRES_DB=predictiondb
+POSTGRES_DB=boilerplatedb