documentation updated
authorebelcrom <ebelcrom@gmail.com>
Sun, 1 Mar 2020 20:24:10 +0000 (21:24 +0100)
committerebelcrom <ebelcrom@gmail.com>
Sun, 1 Mar 2020 20:24:10 +0000 (21:24 +0100)
README.md

index d0e4fbe20f9ab81e3c146d0ce531d6b5082f1012..8616319c29f9d84db2232cadcea38fc13a6bd2b7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,11 +1,10 @@
 # garnod.git
 
-This is garage node application.
+This is the garage node server application.
 
 ## Getting started
 
-These instructions will get you a copy of the project up and running on your local
-machine.
+These instructions let get you a copy of the project and running it on your local machine.
 
 ### Installing
 
@@ -15,4 +14,23 @@ Get the project using git:
 git clone https://binomiant.duckdns.org/MpqU9XX8/garnod.git 
 ```
 
-...
+Install required packages:
+
+```
+cd garnod.git
+npm install
+```
+
+Setup your mongodb database:
+
+```
+node init/initdb.js
+```
+
+Now you can start the server:
+
+```
+npm start
+```
+
+To see debug information of express type `DEBUG=*` before the command, to see debug information of the application set the environment variable `LOGLEVEL=debug`.