Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/suissa/meanis
MEANIS (Mongo, Express, Angular, Node, I18next, Socket.io) - A Simple, Scalable and Easy starting point for JS centric web apps - utilizing many of the best practices we've found on the way
https://github.com/suissa/meanis
Last synced: 8 days ago
JSON representation
MEANIS (Mongo, Express, Angular, Node, I18next, Socket.io) - A Simple, Scalable and Easy starting point for JS centric web apps - utilizing many of the best practices we've found on the way
- Host: GitHub
- URL: https://github.com/suissa/meanis
- Owner: suissa
- Created: 2013-07-31T13:47:11.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2013-07-26T11:06:53.000Z (over 11 years ago)
- Last Synced: 2024-04-10T21:19:08.318Z (7 months ago)
- Language: JavaScript
- Homepage: http://chrisenytc.github.io/meanis
- Size: 180 KB
- Stars: 0
- Watchers: 1
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MEANIS Stack
MEANIS is a fork of [MEAN](https://github.com/linnovate/mean). MEANIS is a boilerplate that provides a nice starting point for MongoDB, Node.js, Express, AngularJS, I18next and Socket.io based applications.
It is designed to give you quick and organized way to start developing of MEANIS 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.
* I18next - Defined as npm module in the [package.json](package.json) file.
* Socket.io - Defined as npm module in the [package.json](package.json) file.
* AngularJS - Defined as bower module in the [bower.json](bower.json) file.
* Twitter Bootstrap - Defined as bower module in the [bower.json](bower.json) file.
* UI Bootstrap - Defined as bower module in the [bower.json](bower.json) file.
## Configuration
See the [config](config/) folder and especially the [config.js](config/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](app/models/article.js) - Where we define our object schema.
* [The Controller](app/controllers/articles.js) - Where we take care of our backend logic.
* [NodeJS Routes](config/routes.js) - Where we define our REST service routes.
* [AngularJs Routes](public/js/config.js) - Where we define our CRUD routes.
* [The AngularJs Service](public/js/services/articles.js) - Where we connect to our REST service.
* [The I18next Service](public/js/services/i18next.js) - Where we connect to our I18next service.
* [The Socket.io Service](public/js/services/socket.io.js) - Where we connect to our Socket.io service.
* [The AngularJs Controller](public/js/controllers/articles.js) - Where we take care of our frontend logic.
* [The AngularJs Views Folder](public/views/articles) - 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](https://npmjs.org/package/mean-logger) for examples.
## More Information
* Visit our [Ninja's Zone](http://www.meanleanstartupmachine.com/) for extended support.
* Visit us at [Linnovate.net](http://www.linnovate.net/).
* Visit us at [Chris.enytc.com](http://chris.enytc.com/).
* Contact amos on any issue via [E-Mail](mailto:[email protected]), [Facebook](https://www.facebook.com/chrisenytc), or [Twitter](https://www.twitter.com/chrisenytc).
## 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.