Merge branch 'master' of https://github.com/mythLabs/api-server-node-…

…express
mythLabs · Dec 8, 2018 · 4f48e08 · 4f48e08
2 parents a86e5d2 + c14de8f
commit 4f48e08
Showing 1 changed file with 20 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,11 +1,29 @@
 # api-server-node-express
 
-Modules tech stack
+A node-express api server with Authentication setup
 
-low level request handling - ['HTTP Module']
+## Modules tech stack
+
+Low level request handling - ['HTTP Module']
 
 Routing,Server logic - ['Body Parser','Morgan','Express']
 
 Database - ['Mongoose','MongoDB']
 
 Authentication - ['Bcrypt-Node','Passport-JWT','Passport-Local','Passport']
+
+Also, vs code debugging enabled.
+
+## How to run
+
+### npm install
+    1. Add your Mongo Db connection string in index.js file.
+
+### npm run dev
+
+## How to debug
+
+### npm run dev
+
+    1.Add a break point
+    2.Then select to node process from vs code debug section have --inspect attached to it.