benraziel / mean

MEAN (Mongo, Express, Angular, Node) - A Simple, Scalable and Easy starting point for JS centric web apps - utilizing many of the best practices we've found on the way

MEAN Stack

MEAN is a boilerplate that provides a nice starting point for MongoDB, Node.js, 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.

Prerequisites

• Node.js - Download and Install Node.js.
• MongoDB - Download and Install MongoDB - Make sure it's running on the default port(27017).

Additional Packages

• Express - Defined as npm module in the package.json file.
• Mongoose - Defined as npm module in the package.json file.
• Passport - Defined as npm module in the package.json file.
• AngularJS - Defined as bower module in the bower.json file.
• Twitter Bootstrap - Defined as bower module in the bower.json file.
• UI Bootstrap - Defined as bower module in the bower.json file.

Configuration

See the config folder and especially the config.js file.

Quick Install

The quickest way to get started with MEAN is to clone the project and utilize it like this:

Install npm (server side) dependencies:

$ npm install

Install bower (client side) dependencies:

$ bower install

Start the server:

$ node server

Then open a browser and go to:

http://localhost:3000

Getting Started

We pre-included an article example, check it out:

• The Model - Where we define our object schema.
• The Controller - Where we take care of our backend logic.
• NodeJS Routes - Where we define our REST service routes.
• AngularJs Routes - Where we define our CRUD routes.
• The AngularJs Service - Where we connect to our REST service.
• The AngularJs Controller - Where we take care of our frontend logic.
• The AngularJs Views Folder - Where we keep our CRUD views.

MEAN Modules

Mean presents a growing eco-system of MEAN based modules in the npm repository, To write (and contribute) your own MEAN based module checkout mean-logger for examples.

More Information

• Visit our Ninja's Zone for extended support.
• Visit us at Linnovate.net.
• Contact amos on any issue via E-Mail, Facebook, or Twitter.

Credits

Inspired by the great work of Madhusudhan Srinivasa

License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.