| 1 |
|
| 2 |
|
| 3 | ## Table of contents
|
| 4 |
|
| 5 | - [AdonisJs Cli 🍺](#adonisjs-cli-)
|
| 6 | - [Installation](#installation)
|
| 7 | - [Usage](#usage)
|
| 8 | - [Moving Forward](#moving-forward)
|
| 9 | - [Tests](#tests)
|
| 10 | - [Release History](#release-history)
|
| 11 | - [Meta](#meta)
|
| 12 |
|
| 13 |
|
| 14 |
|
| 15 | # AdonisJs Cli 🍺
|
| 16 | > Scaffolding tool for Adonisjs
|
| 17 |
|
| 18 | [![NPM Version][npm-image]][npm-url]
|
| 19 | [![Build Status][travis-image]][travis-url]
|
| 20 | [![Appveyor][appveyor-image]][appveyor-url]
|
| 21 | [![Coveralls][coveralls-image]][coveralls-url]
|
| 22 |
|
| 23 | Adonis cli is built on top of [Adonis ace](https://github.com/adonisjs/ace) and helps you scaffold new Adonisjs projects.
|
| 24 |
|
| 25 | Also it can proxy all the ace commands for a project, so that you can run them using the global `adonis` command.
|
| 26 |
|
| 27 | <img src="http://res.cloudinary.com/adonisjs/image/upload/q_100/v1497112678/adonis-purple_pzkmzt.svg" width="200px" align="right" hspace="30px" vspace="100px">
|
| 28 |
|
| 29 | ## Installation
|
| 30 | You can install the package from npm.
|
| 31 | ```bash
|
| 32 | npm i --global @adonisjs/cli
|
| 33 | ```
|
| 34 |
|
| 35 | ## Usage
|
| 36 |
|
| 37 | ```bash
|
| 38 | adonis new yardstick
|
| 39 |
|
| 40 | # start http server
|
| 41 | adonis serve --dev
|
| 42 | ```
|
| 43 |
|
| 44 | ## Moving Forward
|
| 45 | Checkout the [official documentation](http://adonisjs.com/guides/installation) at the AdonisJs website for more info.
|
| 46 |
|
| 47 | ## Tests
|
| 48 | Tests are written using [japa](http://github.com/thetutlage/japa). Run the following commands to run tests.
|
| 49 |
|
| 50 | ```bash
|
| 51 | npm run test:local
|
| 52 |
|
| 53 | # report coverage
|
| 54 | npm run test
|
| 55 |
|
| 56 | # on windows
|
| 57 | npm run test:win
|
| 58 | ```
|
| 59 |
|
| 60 | ## Release History
|
| 61 |
|
| 62 | Checkout [CHANGELOG.md](CHANGELOG.md) file for release history.
|
| 63 |
|
| 64 | ## Meta
|
| 65 |
|
| 66 | AdonisJs – [@adonisframework](https://twitter.com/adonisframework) – virk@adonisjs.com
|
| 67 |
|
| 68 | Checkout [LICENSE.txt](LICENSE.txt) for license information
|
| 69 |
|
| 70 | Harminder Virk (Aman) - [https://github.com/thetutlage](https://github.com/thetutlage)
|
| 71 |
|
| 72 | [appveyor-image]: https://img.shields.io/appveyor/ci/thetutlage/adonis-cli/master.svg?style=flat-square
|
| 73 |
|
| 74 | [appveyor-url]: https://ci.appveyor.com/project/thetutlage/adonis-cli
|
| 75 |
|
| 76 | [npm-image]: https://img.shields.io/npm/v/@adonisjs/cli.svg?style=flat-square
|
| 77 | [npm-url]: https://npmjs.org/package/@adonisjs/cli
|
| 78 |
|
| 79 | [travis-image]: https://img.shields.io/travis/adonisjs/adonis-cli/master.svg?style=flat-square
|
| 80 | [travis-url]: https://travis-ci.org/adonisjs/adonis-cli
|
| 81 |
|
| 82 | [coveralls-image]: https://img.shields.io/coveralls/adonisjs/adonis-cli/develop.svg?style=flat-square
|
| 83 |
|
| 84 | [coveralls-url]: https://coveralls.io/github/adonisjs/adonis-cli
|