@adonisjs/framework/README.md

Adonis framework makes it easy for you to write webapps with less code

# Adonis Framework :triangular_ruler:

This repo contains the core modules for the AdonisJs framework. You must checkout the source code or the API docs on official website to learn more.

<br />
<hr />
<br />

[![NPM Version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Appveyor][appveyor-image]][appveyor-url]
[![Coveralls][coveralls-image]][coveralls-url]
[![FOSSA Status][fossa-image]][fossa-url]
[![Pr's Welcome][pr-welcoming-image]][pr-welcoming-url]

<img src="https://res.cloudinary.com/adonisjs/image/upload/q_100/v1497112678/adonis-purple_pzkmzt.svg" width="200px" align="right" hspace="30px" vspace="140px">

## What's in the box?

This repo contains following providers.

1. Router
2. Request & Response
3. Http Server
4. Config
5. Env
6. Views
7. Static Files Middleware
8. Hashing Module
9. Encrypter
10. Logger
11. Exceptions Handler

## Node/OS Target

This repo/branch is supposed to run fine on all major OS platforms and targets `Node.js >= 8.0.0`

## Development

Great! If you are planning to contribute to the framework, make sure to adhere to following conventions, since a consistent code-base is always joy to work with.

Run the following command to see list of available npm scripts.

```
npm run
```

### Tests & Linting

1. Lint your code using standardJs. Run `npm run lint` command to check if there are any linting errors.
2. Make sure you write tests for all the changes/bug fixes.
3. Also you can write **regression tests**, which shows that something is failing but doesn't breaks the build. Which is actually a nice way to show that something fails. Regression tests are written using `test.failing()` method.
4. Make sure all the tests are passing on `travis` and `appveyor`.

### General Practices

Since Es6 is in, you should strive to use latest features. For example:

1. Use `Spread` over `arguments` keyword.
2. Never use `bind` or `call`. After calling these methods, we cannot guarantee the scope of any methods and in AdonisJs codebase we do not override the methods scope.
3. Make sure to write proper docblock.

## Issues & PR

It is always helpful if we try to follow certain practices when creating issues or PR's, since it will save everyone's time.

1. Always try creating regression tests when you find a bug (if possible).
2. Share some context on what you are trying to do, with enough code to reproduce the issue.
3. For general questions, please create a forum thread.
4. When creating a PR for a feature, make sure to create a parallel PR for docs too.


## Regression Tests

Regression tests are tests, which shows how a piece of code fails under certain circumstance, but the beauty is even after the failure, the test suite will never fail. Actually is a nice way to notify about bugs, but making sure everything is green.

The regression tests are created using

```
test.failing('2 + 2 is always 4, but add method returns 6', (assert) => {
 assert.true(add(2, 2), 4)
})
```

Now since the `add` method has a bug, it will return `6` instead of `4`. But the build will pass.

[appveyor-image]: https://img.shields.io/appveyor/ci/thetutlage/adonis-framework/master.svg?style=flat-square

[appveyor-url]: https://ci.appveyor.com/project/thetutlage/adonis-framework

[npm-image]: https://img.shields.io/npm/v/@adonisjs/framework.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@adonisjs/framework

[travis-image]: https://img.shields.io/travis/adonisjs/adonis-framework/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/adonisjs/adonis-framework

[coveralls-image]: https://img.shields.io/coveralls/adonisjs/adonis-framework/develop.svg?style=flat-square

[coveralls-url]: https://coveralls.io/github/adonisjs/adonis-framework

[fossa-image]: https://app.fossa.io/api/projects/git%2Bgithub.com%2Fadonisjs%2Fadonis-framework.svg?type=shield
[fossa-url]: https://app.fossa.io/projects/git%2Bgithub.com%2Fadonisjs%2Fadonis-framework?ref=badge_shield 

[pr-welcoming-image]: https://img.shields.io/badge/PRs%20-welcome-brightgreen.svg
[pr-welcoming-url]: https://adonisjs.com/docs/contribution-guide

## License
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fadonisjs%2Fadonis-framework.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fadonisjs%2Fadonis-framework?ref=badge_large)