| 1 | <p align="center">
|
| 2 | <a href="http://adonisjs.com"><img src="https://cloud.githubusercontent.com/assets/2793951/19925021/865beda4-a0ee-11e6-85bb-20ccd8f72211.png" alt="AdonisJs Framework"></a>
|
| 3 | </p>
|
| 4 |
|
| 5 | <p align="center">
|
| 6 | <a href="https://www.npmjs.com/package/adonis-framework"><img src="https://img.shields.io/npm/v/adonis-framework.svg?style=flat-square" alt="Version"></a>
|
| 7 | <a href="https://travis-ci.org/adonisjs/adonis-framework"><img src="https://img.shields.io/travis/adonisjs/adonis-framework/master.svg?style=flat-square" alt="Build Status"></a>
|
| 8 | <a href="https://coveralls.io/github/adonisjs/adonis-framework?branch=master"><img src="https://img.shields.io/coveralls/adonisjs/adonis-framework/master.svg?style=flat-square" alt="Coverage Status"></a>
|
| 9 | <a href="https://www.npmjs.com/package/adonis-framework"><img src="https://img.shields.io/npm/dt/adonis-framework.svg?style=flat-square" alt="Downloads"></a>
|
| 10 | <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/npm/l/adonis-framework.svg?style=flat-square" alt="License"></a>
|
| 11 | </p>
|
| 12 |
|
| 13 | <p align="center">
|
| 14 | <a href="https://gitter.im/adonisjs/adonis-framework"><img src="https://img.shields.io/badge/gitter-join%20us-1DCE73.svg?style=flat-square" alt="Gitter"></a>
|
| 15 | <a href="https://trello.com/b/yzpqCgdl/adonis-for-humans"><img src="https://img.shields.io/badge/trello-roadmap-89609E.svg?style=flat-square" alt="Trello"></a>
|
| 16 | <a href="https://www.patreon.com/adonisframework"><img src="https://img.shields.io/badge/patreon-support%20AdonisJs-brightgreen.svg?style=flat-square" alt="Support AdonisJs"></a>
|
| 17 | </p>
|
| 18 |
|
| 19 | <br>
|
| 20 |
|
| 21 | AdonisJs is a MVC framework for Node.js built around practical use cases to give you a perfect solution that meets all of your needs. We focus on writing elegant code and being one of the most stable frameworks in the Node Community. :evergreen_tree:
|
| 22 |
|
| 23 | It is the first Node.js framework with support for [Dependency Injection](http://adonisjs.com/docs/controllers#_dependency_injection) and to have a lean [IoC Container](http://adonisjs.com/docs/ioc-container) to help you resolve and mock dependencies. It borrows the concept of [Service Providers](http://adonisjs.com/docs/ioc-container#_service_providers) from the popular [PHP framework Laravel](https://laravel.com) that lets you easily write scalable applications.
|
| 24 |
|
| 25 | You can learn more about AdonisJs and all of its awesomeness on http://adonisjs.com :rocket:
|
| 26 |
|
| 27 | <br>
|
| 28 | <hr>
|
| 29 | <br>
|
| 30 |
|
| 31 | ## <a name="requirements"></a>Requirements
|
| 32 |
|
| 33 | AdonisJs is built on the top of ES2015, which makes the code more enjoyable and cleaner to read. It doesn't make use of any transpilers and depends upon Core V8 implemented features.
|
| 34 |
|
| 35 | For these reasons, AdonisJs targets Node.js `4.0` or higher.
|
| 36 |
|
| 37 | <br>
|
| 38 | ## <a name="getting-started"></a>Getting Started
|
| 39 |
|
| 40 | AdonisJs provides a [CLI tool](https://github.com/adonisjs/adonis-cli) to scaffold and generate a project with all required dependencies.
|
| 41 |
|
| 42 | ```bash
|
| 43 | $ npm i -g adonis-cli
|
| 44 | ```
|
| 45 |
|
| 46 | ```bash
|
| 47 | $ adonis new awesome-project
|
| 48 | $ cd awesome-project
|
| 49 | $ npm run start
|
| 50 | ```
|
| 51 |
|
| 52 | :point_right: [Read the Official Documentation](http://adonisjs.com/docs/installation)
|
| 53 |
|
| 54 | <br>
|
| 55 | ## <a name="contribution-guidelines"></a>Contribution Guidelines
|
| 56 |
|
| 57 | In favor of active development we accept contributions from everyone. You can contribute by submitting a bug, creating pull requests or even improving documentation.
|
| 58 |
|
| 59 | You can find a complete guide to be followed strictly before submitting your pull requests in the [Official Documentation](http://adonisjs.com/docs/contributing).
|