|
| 1 | +[](http://meanjs.org/) |
| 2 | + |
| 3 | +[](https://travis-ci.org/meanjs/mean) |
| 4 | +[](https://david-dm.org/meanjs/mean) |
| 5 | + |
| 6 | +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 | + |
| 8 | +## Before You Begin |
| 9 | +Before you begin we recommend you read about the basic building blocks that assemble a MEAN.JS application: |
| 10 | +* 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. |
| 11 | +* Express - The best way to understand express is through its [Official Website](http://expressjs.com/), particularly [The Express Guide](http://expressjs.com/guide.html); you can also go through this [StackOverflow Thread](http://stackoverflow.com/questions/8144214/learning-express-for-node-js) for more resources. |
| 12 | +* 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/). |
| 13 | +* 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. |
| 14 | + |
| 15 | + |
| 16 | +## Prerequisites |
| 17 | +Make sure you have installed all these prerequisites on your development machine. |
| 18 | +* 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. |
| 19 | +* MongoDB - [Download & Install MongoDB](http://www.mongodb.org/downloads), and make sure it's running on the default port (27017). |
| 20 | +* 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 | + |
| 22 | +``` |
| 23 | +$ npm install -g bower |
| 24 | +``` |
| 25 | + |
| 26 | +* 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 | + |
| 28 | +``` |
| 29 | +$ sudo npm install -g grunt-cli |
| 30 | +``` |
| 31 | + |
| 32 | +## Downloading MEAN.JS |
| 33 | +There are several ways you can get the MEAN.JS boilerplate: |
| 34 | + |
| 35 | +### Yo Generator |
| 36 | +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. |
| 37 | + |
| 38 | +### Cloning The GitHub Repository |
| 39 | +You can also use Git to directly clone the MEAN.JS repository: |
| 40 | +``` |
| 41 | +$ git clone https://github.com/meanjs/mean.git meanjs |
| 42 | +``` |
| 43 | +This will clone the latest version of the MEAN.JS repository to a **meanjs** folder. |
| 44 | + |
| 45 | +### Downloading The Repository Zip File |
| 46 | +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: |
| 47 | +``` |
| 48 | +$ wget https://github.com/meanjs/mean/archive/master.zip -O meanjs.zip; unzip meanjs.zip; rm meanjs.zip |
| 49 | +``` |
| 50 | +Don't forget to rename **mean-master** after your project name. |
| 51 | + |
| 52 | +## Quick Install |
| 53 | +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 | + |
| 55 | +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 | + |
| 57 | +To install Node.js dependencies you're going to use npm again, in the application folder run this in the command-line: |
| 58 | + |
| 59 | +``` |
| 60 | +$ npm install |
| 61 | +``` |
| 62 | + |
| 63 | +This command does a few things: |
| 64 | +* First it will install the dependencies needed for the application to run. |
| 65 | +* If you're running in a development environment, it will then also install development dependencies needed for testing and running your application. |
| 66 | +* Finally, when the install process is over, npm will initiate a bower installcommand to install all the front-end modules needed for the application |
| 67 | + |
| 68 | +## Running Your Application |
| 69 | +After the install process is over, you'll be able to run your application using Grunt, just run grunt default task: |
| 70 | + |
| 71 | +``` |
| 72 | +$ grunt |
| 73 | +``` |
| 74 | + |
| 75 | +Your application should run on the 3000 port so in your browser just go to [http://localhost:3000](http://localhost:3000) |
| 76 | + |
| 77 | +That's it! your application should be running by now, to proceed with your development check the other sections in this documentation. |
| 78 | +If you encounter any problem try the Troubleshooting section. |
| 79 | + |
| 80 | +## Development and deployment With Docker |
| 81 | + |
| 82 | +* Install [Docker](http://www.docker.com/) |
| 83 | +* Install [Fig](https://github.com/orchardup/fig) |
| 84 | + |
| 85 | +* Local development and testing with fig: |
| 86 | +```bash |
| 87 | +$ fig up |
| 88 | +``` |
| 89 | + |
| 90 | +* Local development and testing with just Docker: |
| 91 | +```bash |
| 92 | +$ docker build -t mean . |
| 93 | +$ docker run -p 27017:27017 -d --name db mongo |
| 94 | +$ docker run -p 3000:3000 --link db:db_1 mean |
| 95 | +$ |
| 96 | +``` |
| 97 | + |
| 98 | +* To enable live reload forward 35729 port and mount /app and /public as volumes: |
| 99 | +```bash |
| 100 | +$ docker run -p 3000:3000 -p 35729:35729 -v /Users/mdl/workspace/mean-stack/mean/public:/home/mean/public -v /Users/mdl/workspa/mean-stack/mean/app:/home/mean/app --link db:db_1 mean |
| 101 | +``` |
| 102 | + |
| 103 | +## Getting Started With MEAN.JS |
| 104 | +You have your application running but there are a lot of stuff to understand, we recommend you'll go over the [Offical Documentation](http://meanjs.org/docs.html). |
| 105 | +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 procees. 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. |
| 106 | + |
| 107 | +## Community |
| 108 | +* Use to [Offical Website](http://meanjs.org) to learn about changes and the roadmap. |
| 109 | +* Join #meanjs on freenode. |
| 110 | +* Discuss it in the new [Google Group](https://groups.google.com/d/forum/meanjs) |
| 111 | +* Ping us on [Twitter](http://twitter.com/meanjsorg) and [Facebook](http://facebook.com/meanjs) |
| 112 | + |
| 113 | +## Live Example |
| 114 | +Browse the live MEAN.JS example on [http://meanjs.herokuapp.com](http://meanjs.herokuapp.com). |
| 115 | + |
| 116 | +## Credits |
| 117 | +Inspired by the great work of [Madhusudhan Srinivasa](https://github.com/madhums/) |
| 118 | +The MEAN name was coined by [Valeri Karpov](http://blog.mongodb.org/post/49262866911/the-mean-stack-mongodb-expressjs-angularjs-and) |
| 119 | + |
| 120 | +## License |
| 121 | +(The MIT License) |
| 122 | + |
| 123 | +Permission is hereby granted, free of charge, to any person obtaining |
| 124 | +a copy of this software and associated documentation files (the |
| 125 | +'Software'), to deal in the Software without restriction, including |
| 126 | +without limitation the rights to use, copy, modify, merge, publish, |
| 127 | +distribute, sublicense, and/or sell copies of the Software, and to |
| 128 | +permit persons to whom the Software is furnished to do so, subject to |
| 129 | +the following conditions: |
| 130 | + |
| 131 | +The above copyright notice and this permission notice shall be |
| 132 | +included in all copies or substantial portions of the Software. |
| 133 | + |
| 134 | +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, |
| 135 | +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
| 136 | +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
| 137 | +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY |
| 138 | +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, |
| 139 | +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
| 140 | +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
0 commit comments