Clean up comments and update README.md

Author: jocodev1

README.md

@@ -1,19 +1,16 @@
 # Colls Framework CLI
 A CLI tool to build project scaffolding for your new Colls API.
 
-## Pre-requisites
-
-- Install & run `MongoDB Server` for your local environment
-- (Optional) Install `nodemon` to run your application.
-
 ## Installation
 Install `colls-api-cli`
 
 ```sh
 npm install colls-api-cli -g
 ```
 
-Navigate to your new desired project location. Run the following command to initiate prompts to begin your build.
+Navigate to your new desired project location.
+
+Run the following command to initiate prompts to begin your build.
 
 ```sh
 colls build
@@ -27,7 +24,25 @@ Next, install all project dependencies.
 npm install
 ```
 
-Now your API setup has been completed and you should be able to run the main `app.js` file to serve your api.
+Now your new API setup has been completed.
+
+## Running the API
+
+I would personally recommend installing `nodemon` to serve your api on your local environment.
+
+```sh
+npm install nodemon -g
+```
+
+Nodemon makes it much easier for development. You can change any code within the `app.js` code structure and nodemon will automatically apply changes and restart the server as soon as you save the changes in your files.
+
+To boot up your server, simply run the following command.
+
+```sh
+nodemon app
+```
+
+## Try it out!
 
 By default, your api will be served on port `3000`. To test your first endpoint, navigate to...
 http://localhost:3000/api

package.json

@@ -1,6 +1,6 @@
 {
   "name": "colls-api-cli",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Colls API CLI tool generate framework files.",
   "main": "bin/colls.js",
   "keywords": [

src/app.js

@@ -6,8 +6,18 @@ const mongoose      = require('mongoose')
 const config        = require('./config/config')
 const middleware    = require('./src/middleware/_common/header')
 
-// DB Configuration
-mongoose.connect(config.database)
+/**
+* DB Configuration
+* 
+* By default, the mongoose connection to your configured Mongo DB has been ignored
+* so that the code will work outside of the box for those who do not have Mongo
+* installed and running.
+*
+* To use Mongo, uncomment the line below and adjust the configuration file accordingly.
+*/
+
+// mongoose.connect(config.database)
+
 
 // App Configuration
 const app = module.exports = express()

src/config/config.js

@@ -1,5 +1,5 @@
 module.exports = {
-    secret: 'secret',
+    secret: 'secret', // you should consider changing this
 
     /**
      * Origins Header Information
@@ -10,16 +10,14 @@ module.exports = {
      */
     prod: {
       origins: [
-        // 'http://your-prod-domain.com',
-        '*' // NOT SECURE
+        '*' // NOT SECURE - Change to 'http://your-prod-domain.com',
       ]
     },
     dev: {
       origins: [
-        // 'http://your-local-domain.com',
-        '*' // NOT SECURE
+        '*' // NOT SECURE - Change to 'http://your-local-domain.com'
       ]
     },
     database: 'mongodb://localhost:27017/<mongo-db-name>',
-    version: 'v1.0'
+    version: 'v1'
 };