|
1 |
| -This is a framework that provides a nice starting point for Mongo, Angular, Epress and Node based projects. |
2 |
| -It is designed to be a starting point for the development of MEAN based web apps. |
3 |
| -### Prerequisites |
4 |
| -Mongo - Download and Install mongo - make sure it's running (deafualt port for the connection is 27017) |
5 |
| -Express - Comes by the npm install |
6 |
| -Angular - Is provide by the node and through the process... |
7 |
| -Node - Install node.js |
8 |
| - |
9 |
| -#### Install |
10 |
| -In the root directory run |
11 |
| -npm install |
12 |
| -to get all of the required node modules needed by MEAN. |
13 |
| - |
14 |
| -### Modules |
15 |
| -Mean is built in a modular fashion and will provide a larger eco-system implemented as node modules. |
| 1 | +# MEAN Stack |
| 2 | + |
| 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 usefull modules like mongoose and passport prebundled and configured. |
| 5 | +We mainly try to take care of the connection points between existing popular frameworks and solve common integration problems. |
| 6 | + |
| 7 | +## 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). |
| 10 | + |
| 11 | +## Additional Packages |
| 12 | +* Express - Defined as npm module in the [Package.json](package.json) file. |
| 13 | +* Mongoose - Defined as npm module in the [Package.json](package.json) file. |
| 14 | +* Passport - Defined as npm module in the [Package.json](package.json) file. |
| 15 | +* AngularJS - Prebundled in the [public](public/) folder. |
| 16 | +* Twitter Bootstrap - Prebundled in the [public](public/) folder. |
| 17 | + |
| 18 | +## Configuration |
| 19 | +See the [config](config/) folder and espically the [config.js](config/config.js) file. |
| 20 | + |
| 21 | +## Quick Start |
| 22 | + |
| 23 | + The quickest way to get started with MEAN is to clone the project and utilize it like this: |
| 24 | + |
| 25 | + Install dependencies: |
| 26 | + |
| 27 | + $ npm install |
| 28 | + |
| 29 | + Start the server: |
| 30 | + |
| 31 | + $ node server |
| 32 | + |
| 33 | +## The Future |
| 34 | + We are currently working on a extendable module system to make this project more like a framework with support for common web development requirements. |
| 35 | + |
| 36 | + |
| 37 | +## More Information |
| 38 | + |
| 39 | + * Visit our [Ninja's Zone](http://www.meanleanstartupmachine.com/) for extended support. |
| 40 | + * Visit us at [Linnovate.net](http://www.linnovate.net/). |
| 41 | + * Contact me on any matter via [EMail ](mailto:[email protected]), [Facebook ](http://www.facebook.com/amoshaviv), or [Twitter ](http://www.twitter.com/amoshaviv). |
| 42 | + |
| 43 | +## License |
| 44 | + |
| 45 | +(The MIT License) |
| 46 | + |
| 47 | +Permission is hereby granted, free of charge, to any person obtaining |
| 48 | +a copy of this software and associated documentation files (the |
| 49 | +'Software'), to deal in the Software without restriction, including |
| 50 | +without limitation the rights to use, copy, modify, merge, publish, |
| 51 | +distribute, sublicense, and/or sell copies of the Software, and to |
| 52 | +permit persons to whom the Software is furnished to do so, subject to |
| 53 | +the following conditions: |
| 54 | + |
| 55 | +The above copyright notice and this permission notice shall be |
| 56 | +included in all copies or substantial portions of the Software. |
| 57 | + |
| 58 | +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, |
| 59 | +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
| 60 | +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
| 61 | +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY |
| 62 | +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, |
| 63 | +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
| 64 | +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
0 commit comments