Skip to content

Commit ab5e57a

Browse files
author
Twana Daniel
committed
Update readME
1 parent fdba532 commit ab5e57a

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# MEAN Stack on Bluemix
1+
# Modern Web Application using MEAN stack
22

3-
<img src="ReadME-Images/mean.jpeg">
3+
<img src="ReadME-Images/Architecture.png">
44

5-
This is a basic boilerplate for the MEAN stack ([MongoDB](https://www.mongodb.org/), [Express](http://expressjs.com/), [AngularJS](https://angularjs.org/) and [Node.js](https://nodejs.org)) on [IBM Bluemix](http://bluemix.net).
5+
This is a basic boilerplate for the MEAN stack ([MongoDB](https://www.mongodb.org/), [Express](http://expressjs.com/), [AngularJS](https://angularjs.org/) and [Node.js](https://nodejs.org)) on [IBM Cloud](http://bluemix.net).
66

7-
This application uses the [Compose for MongoDB service](https://console.bluemix.net/catalog/services/compose-for-mongodb) and [Node.js runtime](https://www.ng.bluemix.net/docs/starters/nodejs/index.html) on Bluemix.
7+
This application uses the [Compose for MongoDB service](https://console.bluemix.net/catalog/services/compose-for-mongodb) and [Node.js runtime](https://www.ng.bluemix.net/docs/starters/nodejs/index.html) on IBM Cloud.
88

99
#### Features
1010
- MVC project structure
1111
- Create, edit and delete user accounts
1212
- Authentication with username/password
1313
- Protected routes that can only be accessed by authenticated users
1414
- Bootstrap CSS framework & [Cosmo theme](https://bootswatch.com/cosmo/)
15-
- HTTPS built-in if deployed to [Bluemix](#deploy-to-bluemix)
15+
- HTTPS built-in if deployed to [IBM Cloud](#deploy-to-bluemix)
1616
- [Mongoose](https://github.com/Automattic/mongoose) for MongoDB interactions.
1717
- [PassportJS](http://passportjs.org) for authentication, with over 300 authentication strategies to pick from.
1818

@@ -31,7 +31,7 @@ This application uses the [Compose for MongoDB service](https://console.bluemix.
3131
6. Run `node server.js` to start your app
3232
7. Open a browser to the link provided in the terminal prompt to view your app
3333

34-
##### Deploy to Bluemix
34+
##### Deploy to IBM Cloud
3535

3636
Option 1 (launch this app directly from this repo):
3737

@@ -41,12 +41,12 @@ Option 2 (deploy from your local machine):
4141

4242
1. Clone or download this repo onto your machine.
4343
2. Open a terminal prompt to the directory of your application.
44-
3. If you don't have a Bluemix account, [create a free one here](https://console.ng.bluemix.net/registration/).
45-
4. Set your Cloud Foundry CLI tool's API endpoint to Bluemix: `bx api https://api.ng.bluemix.net `
46-
5. Login to Bluemix via the command line: `bx login`
47-
6. Target your Bluemix ORG and SPACE `bx target -o ORG -s SPACE`
48-
7. Create the instance of Compose for MongoDB on Bluemix: `bx cf create-service compose-for-mongodb Standard mongodb`
49-
8. Push your app to bluemix with `bx cf push`
44+
3. If you don't have an account, [create a free one here](https://console.ng.bluemix.net/registration/).
45+
4. Set your Cloud Foundry CLI tool's API endpoint to: `bx api https://api.ng.bluemix.net `
46+
5. Login to your account via the command line: `bx login`
47+
6. Target your account ORG and SPACE `bx target -o ORG -s SPACE`
48+
7. Create the instance of Compose for MongoDB on IBM Cloud: `bx cf create-service compose-for-mongodb Standard mongodb`
49+
8. Push your app to IBM Cloud with `bx cf push`
5050
9. Done, the app should be looking like:<img src="ReadME-Images/live-app.png">
5151

5252

@@ -59,7 +59,7 @@ Create a [GitHub issue](https://github.com/IBM-Bluemix/nodejs-MEAN-stack/issues/
5959

6060
| File | Description |
6161
| ---------------------------------- | ------------------------------------------------------------ |
62-
| [**manifest.yml**](./manifest.yml) | File that defines Bluemix deployment paramaters. [More info here](https://www.ng.bluemix.net/docs/manageapps/depapps.html#appmanifest)
62+
| [**manifest.yml**](./manifest.yml) | File that defines deployment paramaters. [More info here](https://www.ng.bluemix.net/docs/manageapps/depapps.html#appmanifest)
6363
| [**.env.example**](./.env.example) | Set custom [environment variables](https://en.wikipedia.org/wiki/Environment_variable) for your application. This is the proper way to store credentials and other sensitive values.
6464
| [**server.js**](./server.js) | Main server file that the Node.js runtime uses. It contains all the server logic.
6565
| [**/server**](./server) | Folder for files used by the Node.js server
@@ -80,7 +80,7 @@ There is also generous commenting throughout the application which helps explain
8080
Please create a pull request with your desired changes.
8181

8282
## Troubleshooting
83-
The primary source of debugging information for your Bluemix app is the logs. To see them, run the following command using the Cloud Foundry CLI:
83+
The primary source of debugging information for your app is the logs. To see them, run the following command using the Cloud Foundry CLI:
8484

8585
```
8686
$ bx cf logs <application-name> --recent
@@ -92,7 +92,7 @@ If you are not sure what your application name is, use this command to print you
9292
$ bx cf apps
9393
```
9494

95-
For more detailed information on troubleshooting your application, see the [Troubleshooting section](https://www.ng.bluemix.net/docs/troubleshoot/tr.html) in the Bluemix documentation.
95+
For more detailed information on troubleshooting your application, see the [Troubleshooting section](https://www.ng.bluemix.net/docs/troubleshoot/tr.html) in the documentation.
9696

9797
## License
9898
See [LICENSE.MD](https://github.com/IBM-Bluemix/Nodejs-MEAN-Stack/blob/master/LICENSE.md) for license information.

ReadME-Images/Architecture.png

42.1 KB
Loading

0 commit comments

Comments
 (0)