adonis-framework

AdonisJS Framework

:pray: This repository contains the core of the AdonisJS framework.

Adonis is a MVC framework for NodeJS built on solid foundations.

It is the first NodeJS framework with support for Dependency Injection and has a lean IoC Container to resolve and mock dependencies. It borrows the concept of Service Providers from the popular PHP framework Laravel to write scalable applications.

You can learn more about AdonisJS and all of its awesomeness on http://adonisjs.com :evergreen_tree:

Table of Contents

• Team Members
• Requirements
• Getting Started
• Contribution Guidelines

Team Members

• Harminder Virk (Caffiene Blogging) [e-mail]

Requirements

AdonisJS is build on the top of ES2015, which makes the code more enjoyable and cleaner to read. It doesn't make use of any transpiler and depends upon Core V8 implemented features.

For these reasons, AdonisJS require you to use node >= 4.0 and npm >= 3.0.

Getting Started

AdonisJS provide a CLI tool to scaffold and generate a project with all required dependencies.

$ npm install -g adonis-cli

$ adonis new awesome-project
$ cd awesome-project
$ npm run start

Official Documentation

Contribution Guidelines

In favor of active development we accept contributions for everyone. You can contribute by submitting a bug, creating pull requests or even improving documentation.

You can find a complete guide to be followed strictly before submitting your pull requests in the Official Documentation.