# @adonisjs/framework > Adonis framework makes it easy for you to write webapps with less code Latest version **5.0.13** (published 2019-02-16) · MIT license · 0 weekly downloads ## Install ```sh npm install @adonisjs/framework pnpm add @adonisjs/framework yarn add @adonisjs/framework bun add @adonisjs/framework ``` Provides the command `framework`. ## Health **Score 35/100 (D)** — status: abandoned. Positive: no vulnerabilities; high maintenance score; popular repo. Warnings: low downloads; no types; no esm support. Negative: abandoned. ## Facts | | | |---|---| | Version | 5.0.13 | | Published | 2019-02-16 | | First published | 2017-06-21 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 24 | | Unpacked size | 209.1 KB | | Known vulnerabilities | 0 (+3 in 3 direct dependencies) | | Install scripts | no | | GitHub stars | 19125 | | Author | adonisjs | | Maintainers | romainlanz, virk | | Keywords | adonis-framework, mvc, mvc-framework | ## Links - npm: https://www.npmjs.com/package/@adonisjs/framework - Repository: https://github.com/adonisjs/adonis-framework - Homepage: https://github.com/adonisjs/adonis-framework#readme - Issues: https://github.com/adonisjs/adonis-framework/issues - npm.io page: https://npm.io/package/@adonisjs/framework ## Dependencies (24) - [haye](https://npm.io/package/haye.md) ^2.0.2 - [debug](https://npm.io/package/debug.md) ^4.1.1 - [youch](https://npm.io/package/youch.md) ^2.0.10 - [dotenv](https://npm.io/package/dotenv.md) ^6.2.0 - [lodash](https://npm.io/package/lodash.md) ^4.17.11 - [edge.js](https://npm.io/package/edge.js.md) ^1.1.4 - [winston](https://npm.io/package/winston.md) ^3.2.1 - [bcryptjs](https://npm.io/package/bcryptjs.md) ^2.4.3 - [node-req](https://npm.io/package/node-req.md) ^2.1.1 - [node-res](https://npm.io/package/node-res.md) 4.1.4 - [parseurl](https://npm.io/package/parseurl.md) ^1.3.2 - [macroable](https://npm.io/package/macroable.md) ^1.0.0 - [resetable](https://npm.io/package/resetable.md) ^1.0.3 - [useragent](https://npm.io/package/useragent.md) ^2.3.0 - [co-compose](https://npm.io/package/co-compose.md) ^4.0.0 - [node-cookie](https://npm.io/package/node-cookie.md) ^2.1.1 - [require-all](https://npm.io/package/require-all.md) ^3.0.0 - [serve-static](https://npm.io/package/serve-static.md) ^1.13.2 - [eventemitter2](https://npm.io/package/eventemitter2.md) ^5.0.1 - [path-to-regexp](https://npm.io/package/path-to-regexp.md) ^2.4.0 - [node-exceptions](https://npm.io/package/node-exceptions.md) ^3.0.0 - [simple-encryptor](https://npm.io/package/simple-encryptor.md) ^2.0.0 - [@adonisjs/middleware-base](https://npm.io/package/@adonisjs/middleware-base.md) ^1.0.0 - [@adonisjs/generic-exceptions](https://npm.io/package/@adonisjs/generic-exceptions.md) ^2.0.1 ## Recent versions - 5.0.13 (latest) — 2019-02-16 - 5.0.12 — 2018-10-16 - 5.0.11 — 2018-10-16 - 5.0.9 — 2018-09-29 - 5.0.8 — 2018-06-05 - 5.0.7 — 2018-06-02 - 5.0.6 — 2018-03-29 - 5.0.5 — 2018-03-15 - 5.0.4 — 2018-02-08 - 5.0.3 — 2018-02-08 - 5.0.2 — 2018-02-08 - 5.0.1 — 2018-02-07 - 5.0.0 — 2018-01-31 - 4.0.31 — 2018-01-19 - 4.0.30 — 2018-01-12 - … 30 more at https://npm.io/package/@adonisjs/framework/versions ## README # 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.

[![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] ## 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) --- _Source: https://npm.io/package/@adonisjs/framework · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._