You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
MEAN.JS is a full-stack JavaScript open-source solution, which provides a solid starting point for [MongoDB](http://www.mongodb.org/), [Node.js](http://www.nodejs.org/), [Express](http://expressjs.com/), and [AngularJS](http://angularjs.org/) based applications. The idea is to solve the common issues with connecting those frameworks, build a robust framework to support daily development needs, and help developers use better practices while working with popular JavaScript components.
7
+
MEAN.JS is a full-stack JavaScript open-source solution, which provides a solid starting point for [MongoDB](http://www.mongodb.org/), [Node.js](http://www.nodejs.org/), [Express](http://expressjs.com/), and [AngularJS](http://angularjs.org/) based applications. The idea is to solve the common issues with connecting those frameworks, build a robust framework to support daily development needs, and help developers use better practices while working with popular JavaScript components.
8
8
9
-
## Before You Begin
10
-
Before you begin we recommend you read about the basic building blocks that assemble a MEAN.JS application:
9
+
## Before You Begin
10
+
Before you begin we recommend you read about the basic building blocks that assemble a MEAN.JS application:
11
11
* MongoDB - Go through [MongoDB Official Website](http://mongodb.org/) and proceed to their [Official Manual](http://docs.mongodb.org/manual/), which should help you understand NoSQL and MongoDB better.
12
12
* Express - The best way to understand express is through its [Official Website](http://expressjs.com/), which has a [Getting Started](http://expressjs.com/starter/installing.html) guide, as well as an [ExpressJS Guide](http://expressjs.com/guide/error-handling.html) guide for general express topics. You can also go through this [StackOverflow Thread](http://stackoverflow.com/questions/8144214/learning-express-for-node-js) for more resources.
13
13
* AngularJS - Angular's [Official Website](http://angularjs.org/) is a great starting point. You can also use [Thinkster Popular Guide](http://www.thinkster.io/), and the [Egghead Videos](https://egghead.io/).
14
14
* Node.js - Start by going through [Node.js Official Website](http://nodejs.org/) and this [StackOverflow Thread](http://stackoverflow.com/questions/2353818/how-do-i-get-started-with-node-js), which should get you going with the Node.js platform in no time.
15
15
16
16
17
17
## Prerequisites
18
-
Make sure you have installed all these prerequisites on your development machine.
19
-
* Node.js - [Download & Install Node.js](http://www.nodejs.org/download/) and the npm package manager, if you encounter any problems, you can also use this [GitHub Gist](https://gist.github.com/isaacs/579814) to install Node.js.
18
+
Make sure you have installed all of the following prerequisites on your development machine:
19
+
* Node.js - [Download & Install Node.js](http://www.nodejs.org/download/) and the npm package manager. If you encounter any problems, you can also use this [GitHub Gist](https://gist.github.com/isaacs/579814) to install Node.js.
20
20
* MongoDB - [Download & Install MongoDB](http://www.mongodb.org/downloads), and make sure it's running on the default port (27017).
21
-
* Bower - You're going to use the [Bower Package Manager](http://bower.io/) to manage your front-end packages, in order to install it make sure you've installed Node.js and npm, then install bower globally using npm:
21
+
* Bower - You're going to use the [Bower Package Manager](http://bower.io/) to manage your front-end packages. Make sure you've installed Node.js and npm first, then install bower globally using npm:
22
22
23
-
```
23
+
```bash
24
24
$ npm install -g bower
25
25
```
26
26
27
-
* Grunt - You're going to use the [Grunt Task Runner](http://gruntjs.com/) to automate your development process, in order to install it make sure you've installed Node.js and npm, then install grunt globally using npm:
27
+
* Grunt - You're going to use the [Grunt Task Runner](http://gruntjs.com/) to automate your development process. Make sure you've installed Node.js and npm first, then install grunt globally using npm:
28
28
29
-
```
29
+
```bash
30
30
$ sudo npm install -g grunt-cli
31
31
```
32
32
33
33
## Downloading MEAN.JS
34
-
There are several ways you can get the MEAN.JS boilerplate:
34
+
There are several ways you can get the MEAN.JS boilerplate:
35
35
36
-
### Yo Generator
37
-
The recommended way would be to use the [Official Yo Generator](http://meanjs.org/generator.html) which will generate the latest stable copy of the MEAN.JS boilerplate and supplies multiple sub-generators to ease your daily development cycles.
36
+
### Yo Generator
37
+
The recommended way would be to use the [Official Yo Generator](http://meanjs.org/generator.html), which generates the latest stable copy of the MEAN.JS boilerplate and supplies multiple sub-generators to ease your daily development cycles.
38
38
39
39
### Cloning The GitHub Repository
40
40
You can also use Git to directly clone the MEAN.JS repository:
This will clone the latest version of the MEAN.JS repository to a **meanjs** folder.
45
45
46
46
### Downloading The Repository Zip File
47
47
Another way to use the MEAN.JS boilerplate is to download a zip copy from the [master branch on GitHub](https://github.com/meanjs/mean/archive/master.zip). You can also do this using `wget` command:
Don't forget to rename **mean-master** after your project name.
52
52
53
53
## Quick Install
54
-
Once you've downloaded the boilerplate and installed all the prerequisites, you're just a few steps away from starting to develop you MEAN application.
54
+
Once you've downloaded the boilerplate and installed all the prerequisites, you're just a few steps away from starting to develop your MEAN application.
55
55
56
-
The first thing you should do is install the Node.js dependencies. The boilerplate comes pre-bundled with a package.json file that contains the list of modules you need to start your application, to learn more about the modules installed visit the NPM & Package.json section.
56
+
The first thing you should do is install the Node.js dependencies. The boilerplate comes pre-bundled with a package.json file that contains the list of modules you need to start your application. To learn more about the modules installed visit the NPM & Package.json section.
57
57
58
-
To install Node.js dependencies you're going to use npm again, in the application folder run this in the command-line:
58
+
To install Node.js dependencies you're going to use npm again. In the application folder run this in the command-line:
59
59
60
-
```
60
+
```bash
61
61
$ npm install
62
62
```
63
63
@@ -67,23 +67,23 @@ This command does a few things:
67
67
* Finally, when the install process is over, npm will initiate a bower install command to install all the front-end modules needed for the application.
68
68
69
69
## Running Your Application
70
-
After the install process is over, you'll be able to run your application using Grunt, just run grunt default task:
70
+
After the install process is over, you'll be able to run your application using Grunt. Just run grunt default task:
71
71
72
-
```
72
+
```bash
73
73
$ grunt
74
74
```
75
75
76
-
Your application should run on the 3000 port so in your browser just go to [http://localhost:3000](http://localhost:3000)
77
-
78
-
That's it! your application should be running by now, to proceed with your development check the other sections in this documentation.
79
-
If you encounter any problem try the Troubleshooting section.
76
+
Your application should run on port 3000, so in your browser just go to [http://localhost:3000](http://localhost:3000)
77
+
78
+
That's it! Your application should be running. To proceed with your development, check the other sections in this documentation.
79
+
If you encounter any problems, try the Troubleshooting section.
80
80
81
81
## Development and deployment With Docker
82
82
83
83
* Install [Docker](http://www.docker.com/)
84
84
* Install [Fig](https://github.com/orchardup/fig)
85
85
86
-
* Local development and testing with fig:
86
+
* Local development and testing with fig:
87
87
```bash
88
88
$ fig up
89
89
```
@@ -96,25 +96,25 @@ $ docker run -p 3000:3000 --link db:db_1 mean
96
96
$
97
97
```
98
98
99
-
* To enable live reload forward 35729 port and mount /app and /public as volumes:
99
+
* To enable live reload, forward port 35729 and mount /app and /public as volumes:
100
100
```bash
101
101
$ docker run -p 3000:3000 -p 35729:35729 -v /Users/mdl/workspace/mean-stack/mean/public:/home/mean/public -v /Users/mdl/workspace/mean-stack/mean/app:/home/mean/app --link db:db_1 mean
102
102
```
103
103
104
104
## Running in a secure environment
105
-
To run your application in a secure manner you'll need to use OpenSSL and generate a set of self-signed certificates. Unix-based users can use the following command:
106
-
```
105
+
To run your application in a secure manner you'll need to use OpenSSL and generate a set of self-signed certificates. Unix-based users can use the following command:
106
+
```bash
107
107
$ sh ./scripts/generate-ssl-certs.sh
108
108
```
109
-
Windows users can follow instructions found [here](http://www.websense.com/support/article/kbarticle/How-to-use-OpenSSL-and-Microsoft-Certification-Authority)
110
-
To generate the key and certificate and place them in the *config/sslcerts* folder.
109
+
Windows users can follow instructions found [here](http://www.websense.com/support/article/kbarticle/How-to-use-OpenSSL-and-Microsoft-Certification-Authority).
110
+
After you've generated the key and certificate, place them in the *config/sslcerts* folder.
111
111
112
112
## Getting Started With MEAN.JS
113
-
You have your application running but there is a lot of stuff to understand, we recommend you'll go over the [Official Documentation](http://meanjs.org/docs.html).
114
-
In the docs we'll try to explain both general concepts of MEAN components and give you some guidelines to help you improve your development process. We tried covering as many aspects as possible, and will keep update it by your request, you can also help us develop the documentation better by checking out the *gh-pages* branch of this repository.
113
+
You have your application running, but there is a lot of stuff to understand. We recommend you go over the [Official Documentation](http://meanjs.org/docs.html).
114
+
In the docs we'll try to explain both general concepts of MEAN components and give you some guidelines to help you improve your development process. We tried covering as many aspects as possible, and will keep it updated by your request. You can also help us develop and improve the documentation by checking out the *gh-pages* branch of this repository.
115
115
116
116
## Community
117
-
* Use to [Offical Website](http://meanjs.org) to learn about changes and the roadmap.
117
+
* Use the [Official Website](http://meanjs.org) to learn about changes and the roadmap.
118
118
* Join #meanjs on freenode.
119
119
* Discuss it in the new [Google Group](https://groups.google.com/d/forum/meanjs)
120
120
* Ping us on [Twitter](http://twitter.com/meanjsorg) and [Facebook](http://facebook.com/meanjs)
0 commit comments