| 1 | <p align="center"><img src="http://codecorico.com/allons-y-logo.png" height="100" /></p>
|
| 2 |
|
| 3 | # Allons-y
|
| 4 |
|
| 5 | [](https://gitter.im/CodeCorico/allons-y?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
| 6 | [](https://badge.fury.io/js/allons-y)
|
| 7 | [](https://waffle.io/CodeCorico/allons-y)
|
| 8 |
|
| 9 | Allons-y is a [Package by feature](http://stackoverflow.com/questions/11733267/is-package-by-feature-approach-good) architect engine.
|
| 10 |
|
| 11 | ## Install
|
| 12 |
|
| 13 | You can easily architect your project by installing the `allons-y` module:
|
| 14 | ```
|
| 15 | npm install allons-y --save
|
| 16 | ```
|
| 17 |
|
| 18 | ## What is Allons-y?
|
| 19 |
|
| 20 | Thanks to NPM and its community, we have access to thousands of varied functionality for our projects. Infortunatly, we have to re-interface them for each new project.
|
| 21 | In the other hand, we have access to some frameworks (like [Sails](http://sailsjs.com/) or [Loop Back](https://loopback.io)) but they comes with a fixed list of modules (like [Express](https://expressjs.com)) that can't be avoided.
|
| 22 |
|
| 23 | [Allons-y](https://github.com/CodeCorico/allons-y) is not a framework. It's a system that allows the developers to architect their projects in a [Package by feature](http://stackoverflow.com/questions/11733267/is-package-by-feature-approach-good) way. With it, you can link your modules wth each other ([read the principles](https://github.com/CodeCorico/allons-y/blob/master/docs/principles.md)).
|
| 24 |
|
| 25 | They are [many modules](https://github.com/CodeCorico/allons-y/blob/master/docs/allons-y-modules.md) that you can use inside your projects to include popular modules like [Express](https://expressjs.com), [Gulp](http://gulpjs.com) and more. You can easily [create your own](https://github.com/CodeCorico/allons-y/blob/master/docs/create-your-own.md) or create private modules that can be included in the Allons-y logic.
|
| 26 |
|
| 27 | ## Documentation
|
| 28 |
|
| 29 | * [Principles](https://github.com/CodeCorico/allons-y/blob/master/docs/principles.md)
|
| 30 | * [Architecture](https://github.com/CodeCorico/allons-y/blob/master/docs/architecture.md)
|
| 31 | * [Live commands](https://github.com/CodeCorico/allons-y/blob/master/docs/live-commands.md)
|
| 32 | * [Processes](https://github.com/CodeCorico/allons-y/blob/master/docs/processes.md)
|
| 33 | * [CLI](https://github.com/CodeCorico/allons-y/blob/master/docs/cli.md)
|
| 34 | * [Logs](https://github.com/CodeCorico/allons-y/blob/master/docs/logs.md)
|
| 35 | * [Environments](https://github.com/CodeCorico/allons-y/blob/master/docs/environments.md)
|
| 36 | * [More allons-y modules](https://github.com/CodeCorico/allons-y/blob/master/docs/allons-y-modules.md)
|
| 37 | * [Create your own open source/private modules](https://github.com/CodeCorico/allons-y/blob/master/docs/create-your-own.md)
|
| 38 |
|
| 39 | ## API
|
| 40 |
|
| 41 | * [$allonsy](https://github.com/CodeCorico/allons-y/blob/master/docs/api-allonsy.md)
|
| 42 | * [$glob](https://github.com/CodeCorico/allons-y/blob/master/docs/api-glob.md)
|
| 43 | * [$processIndex](https://github.com/CodeCorico/allons-y/blob/master/docs/api-processIndex.md)
|
| 44 | * [$commander](https://github.com/CodeCorico/allons-y/blob/master/docs/api-commander.md)
|
| 45 |
|
| 46 | ## Want to help?
|
| 47 |
|
| 48 | Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our [guidelines for contributing](CONTRIBUTING.md) and then check out one of [our issues](https://github.com/CodeCorico/allons-y/issues).
|