Skip to content
This repository was archived by the owner on Aug 30, 2021. It is now read-only.

Commit c5dbb93

Browse files
committed
Adding explanation for environments to README
1 parent f6801c5 commit c5dbb93

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
# MEAN Stack
22

3-
MEAN is a boilerplate that provides a nice starting point for MongoDB, Node.js, Express, and AngularJS based applications.
4-
It is designed to give you quick and organized way to start developing of MEAN based web apps with useful modules like mongoose and passport pre-bundled and configured.
5-
We mainly try to take care of the connection points between existing popular frameworks and solve common integration problems.
3+
MEAN is a boilerplate that provides a nice starting point for [MongoDB](http://www.mongodb.org/), [Node.js](http://www.nodejs.org/), Express, and AngularJS based applications. It is designed to give you quick and organized way to start developing of MEAN based web apps with useful modules like mongoose and passport pre-bundled and configured. We mainly try to take care of the connection points between existing popular frameworks and solve common integration problems.
64

75
## Prerequisites
8-
* Node.js - Download and Install [Node.js](http://www.nodejs.org/).
9-
* MongoDB - Download and Install [MongoDB](http://www.mongodb.org/) - Make sure it's running on the default port(27017).
6+
* Node.js - Download and Install [Node.js](http://www.nodejs.org/download/). You can also follow [this gist](https://gist.github.com/isaacs/579814) for a quick and easy way to install Node.js and npm
7+
* MongoDB - Download and Install [MongoDB](http://www.mongodb.org/downloads) - Make sure it's running on the default port (27017).
108

119
### Optional (Requirements for Grunt)
1210
* Ruby - Download and Install [Ruby](http://www.ruby-lang.org/)
@@ -55,6 +53,16 @@ There are three environments provided by default, __development__, __test__, and
5553
* clientSecret
5654
* callbackURL
5755

56+
To run with a different environment, just specify NODE_ENV as you call grunt:
57+
58+
$ NODE_ENV=test grunt
59+
60+
If you are using node instead of grunt, it is very similar:
61+
62+
$ NODE_ENV=test node server
63+
64+
NOTE: Running Node.js applications in the __production__ environment enables caching, which is disabled by default in all other environments.
65+
5866
## Getting Started
5967
We pre-included an article example, check it out:
6068
* [The Model](app/models/article.js) - Where we define our object schema.

0 commit comments

Comments
 (0)