From ed2b5b7805e35b0a3655a9a7fd5ce29b90f8de8d Mon Sep 17 00:00:00 2001 From: ebelcrom Date: Sun, 1 Mar 2020 21:24:10 +0100 Subject: [PATCH] documentation updated --- README.md | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d0e4fbe..8616319 100644 --- 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`. -- 2.30.2