Merge pull request #26 from IBM-Cloud/icd-mongoDB

More changes to the app

Author: data-henrik

.env.example

@@ -1,9 +1,10 @@
 # This value is the salt used to encrypt sessions. Makeup a long string of text for this value. This is a MANDATORY value for your application.
 SESSION_SECRET=
 
-# URL for your local mongodb installation. The below value is likely correct unless you setup your MongoDB configuration differently.
-LOCAL_MONGODB_URL=mongodb://localhost:27017
+# URL for your mongodb instance on IBM Cloud. 
+MONGODB_URL=
+
 # Certificate - needed for connecting to IBM Cloud Databases for MongoDB
 CERTIFICATE_BASE64=
-PORT=6001
+PORT=6020
 BIND=0.0.0.0

Dockerfile

@@ -20,5 +20,5 @@ COPY ./server.js /src/server.js
 COPY ./.env /src/.env
 
 
-EXPOSE 6001
+EXPOSE 6020
 CMD [ "npm", "start" ]

README.md

@@ -22,18 +22,29 @@ This application uses the [IBM Cloud Databases for MongoDB service](https://clou
 - [Cloud Foundry Command Line Tool](https://docs.cloudfoundry.org/devguide/installcf/)
 
 ## Getting Started
-##### Local Application Development
+##### Run the application locally
 1. Clone or download this repo onto your machine.
-2. Install [application requirements](#application-requirements) if not done so already.
-3. Open application directory in your terminal and run `npm install`
-4. Rename `.env.example` file to `.env`.  Edit the contents as needed, at a minimum adding your own SESSION_SECRET.
-5. Start up your local MongoDB server (typically just `mongod`, see docs [here](https://docs.mongodb.org/getting-started/shell/installation/))
-6. Run `node server.js` to start your app
-7. Open a browser to the link provided in the terminal prompt to view your app
-
-Note that the code assumes a secured connection to MongoDB using SSL and a certificate. This way you can run the app locally but connect to IBM Cloud Databases for MongoDB.
-
-An alternative way of local development is using the provided Dockerfile.
+1. Install [application requirements](#application-requirements) if not done so already.
+1. Open application directory in your terminal and run `npm install`
+1. If you don't have an account, [create a free one here](https://cloud.ibm.com).
+1. Login to your account via the command line: `ibmcloud login`
+1. Target your account ORG and SPACE  `ibmcloud target --cf`
+1. Create the instance of Compose for MongoDB on IBM Cloud:  `ibmcloud cf create-service databases-for-mongodb standard mean-starter-mongodb`
+1. Rename `.env.example` file to `.env` and run `ibmcloud cf service-key mean-starter-mongodb "Service credentials-1"` for MONGODB_URL and CERTIFICATE_BASE64. Choose your own SESSION_SECRET.
+1. Run `node server.js` to start your app
+1. Open a browser to the link provided in the terminal prompt to view your app
+
+> Note that the code assumes a secured connection to MongoDB using SSL and a certificate. This way you can run the app locally but connect to IBM Cloud Databases for MongoDB.
+
+An alternative way of running locally is using the provided `Dockerfile`.
+- Install docker on your machine and build the docker image
+  ```
+   docker build . -t mean-stack:v1.0.0
+  ```
+- Run the app locally
+  ```
+   docker run -p 6020:6020 -ti mean-stack:v1.0.0
+  ```
 
 ##### Deploy to IBM Cloud
 
@@ -52,11 +63,9 @@ Option 2 (deploy from your local machine):
 7. Push your app to IBM Cloud with `ibmcloud cf push`
 8. Done, the app should be looking like:<img src="ReadME-Images/live-app.png">
 
-
-
 #### Problems or Questions?
 
-Create a [GitHub issue](https://github.com/IBM-Cloud/nodejs-MEAN-stack/issues/new) for questions or problems occurs using this demo. 
+Create a [GitHub issue](https://github.com/IBM-Cloud/nodejs-MEAN-stack/issues/new) for questions or problems occurs using this demo.
 
 ## Critical Files & Folders
 

package-lock.json

@@ -21,7 +21,7 @@ var express = require('express'),// server middleware
     appEnv = cfenv.getAppEnv(),// Grab environment variables
 
     User = require('./server/models/user.model');
-    
+
 
 /********************************
 Local Environment Variables
@@ -30,26 +30,26 @@ if(appEnv.isLocal){
     require('dotenv').load();// Loads .env file into environment
 }
 
-/******************************** 
+/********************************
  MongoDB Connection
  ********************************/
 
 //Detects environment and connects to appropriate DB
 if(appEnv.isLocal){
     var ca = Buffer.from(process.env.CERTIFICATE_BASE64, 'base64');
     mongoDbOptions = {
-        useNewUrlParser: true,  
+        useNewUrlParser: true,
         ssl: true,
         sslValidate: true,
         sslCA: ca
   };
-    mongoose.connect(process.env.LOCAL_MONGODB_URL, mongoDbOptions)
+    mongoose.connect(process.env.MONGODB_URL, mongoDbOptions)
         .then(res => console.log(res))
         .catch(function (reason) {
             console.log('Unable to connect to the mongodb instance. Error: ', reason);
         });
-    sessionDB = process.env.LOCAL_MONGODB_URL;
-    console.log('Your MongoDB is running at ' + process.env.LOCAL_MONGODB_URL);
+    sessionDB = process.env.MONGODB_URL;
+    console.log('Your MongoDB is running at ' + process.env.MONGODB_URL);
 }
 // Connect to MongoDB Service on IBM Cloud
 else if(!appEnv.isLocal) {