Merge remote-tracking branch 'upstream/master'

.gitignore

@@ -0,0 +1,31 @@
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+.vscode/
+
+# Mac OS junk
+.DS_Store

README.md

@@ -1,9 +1,9 @@
-# Design-Initiative-Dashboard
+# Design Initiative Dashboard
 
 
 ### Folder structure
 
-```sh
+```
   
   1. client folder contains all the front-end related stuff.
 
@@ -13,21 +13,21 @@
 
 ### Server-side 
 
-```sh
+```
 
   1. cd config - (contains all the configuration files)
   2. cd controllers - (contains all the logic for APIs)
   3. cd models - (contains all the database schemas)
   4. cd routes - (Defined all the routes for APIs)
-  5. cd tets - (contains files for unit-testing APIs)
+  5. cd tests - (contains files for unit-testing APIs)
 
 ```
 
 ### Set-up locally and run
 
 1. Add .env file in the root directory of server
 
-```sh
+```
 
   MONGO_URI = '<YOUR_MONGODB_URL>'
   PORT = 5000
@@ -36,22 +36,22 @@
 ```
 2. Install dependencies on server-side
 
-```sh
+```
 
   > cd server
    npm install
 
 ```
 3. To run backend (development mode)
 
-```sh
+```
    > cd server
    npm run dev
 
 ```
 4. Install dependencies on client-side
 
-```sh
+```
 
    > cd client
    npm install
@@ -60,7 +60,7 @@
 
 5. To run frontend
 
-```sh
+```
 
    > cd client
    npm run start
@@ -69,7 +69,7 @@
 
 6. Ports:
 
-```sh
+```
 
     1. Backend running on: 5000
     2. Frontend running on: 3000