This repository has been archived by the owner on Aug 30, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
64 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 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](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 - Pre-bundled in the [public](public/) folder. | ||
* Twitter Bootstrap - Pre-bundled in the [public](public/) folder. | ||
|
||
## Configuration | ||
See the [config](config/) folder and especially 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 it more like a framework with support for modern 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 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 | ||
|
||
(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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters