From 249c246778e818e07e5c945b21e148a717b5ac6d Mon Sep 17 00:00:00 2001 From: Amos Haviv Date: Thu, 20 Jun 2013 15:14:06 +0300 Subject: [PATCH 1/5] Update README.md --- README.md | 79 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 64 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 8b128ba5e4..3f3e349c3d 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,64 @@ -This is a framework that provides a nice starting point for Mongo, Angular, Epress and Node based projects. -It is designed to be a starting point for the development of MEAN based web apps. -### Prerequisites -Mongo - Download and Install mongo - make sure it's running (deafualt port for the connection is 27017) -Express - Comes by the npm install -Angular - Is provide by the node and through the process... -Node - Install node.js - -#### Install -In the root directory run -npm install -to get all of the required node modules needed by MEAN. - -### Modules -Mean is built in a modular fashion and will provide a larger eco-system implemented as node modules. +# 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 usefull modules like mongoose and passport prebundled 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](http://www.nodejs.org/). +* MongoDB - Download and Install [MongoDB](http://www.mongodb.org/) - Make sure it's running on the default port(27017). + +## Additional Packages +* Express - Defined as npm module in the [Package.json](package.json) file. +* Mongoose - Defined as npm module in the [Package.json](package.json) file. +* Passport - Defined as npm module in the [Package.json](package.json) file. +* AngularJS - Prebundled in the [public](public/) folder. +* Twitter Bootstrap - Prebundled in the [public](public/) folder. + +## Configuration +See the [config](config/) folder and espically the [config.js](config/config.js) file. + +## Quick Start + + The quickest way to get started with MEAN is to clone the project and utilize it like this: + + Install dependencies: + + $ npm install + + Start the server: + + $ node server + +## The Future + We are currently working on a extendable module system to make this project more like a framework with support for common web development requirements. + + +## More Information + + * Visit our [Ninja's Zone](http://www.meanleanstartupmachine.com/) for extended support. + * Visit us at [Linnovate.net](http://www.linnovate.net/). + * Contact me on any matter via [EMail](mailto:mail@amoshaviv.com), [Facebook](http://www.facebook.com/amoshaviv), or [Twitter](http://www.twitter.com/amoshaviv). + +## 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. From c849b8544a1f13dff957a1b4cadde63c72037a92 Mon Sep 17 00:00:00 2001 From: Amos Haviv Date: Thu, 20 Jun 2013 15:19:48 +0300 Subject: [PATCH 2/5] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3f3e349c3d..b473b216d7 100644 --- a/README.md +++ b/README.md @@ -31,14 +31,14 @@ See the [config](config/) folder and espically the [config.js](config/config.js) $ node server ## The Future - We are currently working on a extendable module system to make this project more like a framework with support for common web development requirements. + We are currently working on a extendable module system to make this project more like a framework with support for common modren web development requirements. ## More Information * Visit our [Ninja's Zone](http://www.meanleanstartupmachine.com/) for extended support. * Visit us at [Linnovate.net](http://www.linnovate.net/). - * Contact me on any matter via [EMail](mailto:mail@amoshaviv.com), [Facebook](http://www.facebook.com/amoshaviv), or [Twitter](http://www.twitter.com/amoshaviv). + * Contact amos on any issue via [EMail](mailto:mail@amoshaviv.com), [Facebook](http://www.facebook.com/amoshaviv), or [Twitter](http://www.twitter.com/amoshaviv). ## License From d6211864e76dbae72b44823f2393f92f2b1553e8 Mon Sep 17 00:00:00 2001 From: Amos Haviv Date: Thu, 20 Jun 2013 15:26:35 +0300 Subject: [PATCH 3/5] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b473b216d7..be1956e5d5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # 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 usefull modules like mongoose and passport prebundled and configured. +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 @@ -12,11 +12,11 @@ We mainly try to take care of the connection points between existing popular fra * Express - Defined as npm module in the [Package.json](package.json) file. * Mongoose - Defined as npm module in the [Package.json](package.json) file. * Passport - Defined as npm module in the [Package.json](package.json) file. -* AngularJS - Prebundled in the [public](public/) folder. -* Twitter Bootstrap - Prebundled in the [public](public/) folder. +* AngularJS - Pre-bundled in the [public](public/) folder. +* Twitter Bootstrap - Pre-bundled in the [public](public/) folder. ## Configuration -See the [config](config/) folder and espically the [config.js](config/config.js) file. +See the [config](config/) folder and especially the [config.js](config/config.js) file. ## Quick Start @@ -31,7 +31,7 @@ See the [config](config/) folder and espically the [config.js](config/config.js) $ node server ## The Future - We are currently working on a extendable module system to make this project more like a framework with support for common modren web development requirements. + We are currently working on a extendable module system to make it more like a framework with support for modern web development requirements. ## More Information From e66533e8c1de9adf2ca26b57a480732c0059c4be Mon Sep 17 00:00:00 2001 From: Amos Haviv Date: Thu, 20 Jun 2013 15:27:48 +0300 Subject: [PATCH 4/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index be1956e5d5..b5991ef9bf 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ See the [config](config/) folder and especially the [config.js](config/config.js * Visit our [Ninja's Zone](http://www.meanleanstartupmachine.com/) for extended support. * Visit us at [Linnovate.net](http://www.linnovate.net/). - * Contact amos on any issue via [EMail](mailto:mail@amoshaviv.com), [Facebook](http://www.facebook.com/amoshaviv), or [Twitter](http://www.twitter.com/amoshaviv). + * Contact amos on any issue via [E-Mail](mailto:mail@amoshaviv.com), [Facebook](http://www.facebook.com/amoshaviv), or [Twitter](http://www.twitter.com/amoshaviv). ## License From 1dd124a5c8827ec54f3e30675778ce8be8b4d966 Mon Sep 17 00:00:00 2001 From: Amos Haviv Date: Thu, 20 Jun 2013 15:29:56 +0300 Subject: [PATCH 5/5] Update server.js --- server.js | 2 -- 1 file changed, 2 deletions(-) diff --git a/server.js b/server.js index 971e465cd4..093f463e15 100755 --- a/server.js +++ b/server.js @@ -1,4 +1,3 @@ - /*! * nodejs-express-mongoose-demo * Copyright(c) 2013 Madhusudhan Srinivasa @@ -39,7 +38,6 @@ require('./config/passport')(passport, config) var app = express() -//require('mean-logger').init(app,db); // express settings require('./config/express')(app, config, passport)