| 1 | # ruo
|
| 2 | > Yet Another RESTful API framework
|
| 3 |
|
| 4 | ## Installation
|
| 5 |
|
| 6 | npm install --save ruo
|
| 7 |
|
| 8 |
|
| 9 | ## Usage
|
| 10 |
|
| 11 | const ruo = require('ruo');
|
| 12 |
|
| 13 | async main() {
|
| 14 | const app = await ruo.createApplicationAsync()
|
| 15 |
|
| 16 | app.use(ruo.restMiddleware())
|
| 17 |
|
| 18 | app.listen(8088)
|
| 19 | }
|
| 20 |
|
| 21 | ## Development
|
| 22 |
|
| 23 | Lint
|
| 24 |
|
| 25 | npm run lint
|
| 26 |
|
| 27 | Test
|
| 28 |
|
| 29 | npm test
|
| 30 |
|
| 31 | Or
|
| 32 |
|
| 33 | npm t
|
| 34 |
|
| 35 | Run particular test
|
| 36 |
|
| 37 | npm t -- -g 'some description'
|
| 38 |
|
| 39 | Commit
|
| 40 |
|
| 41 | git cz
|
| 42 |
|
| 43 | ## Credit
|
| 44 |
|
| 45 | * https://github.com/apigee-127/sway
|
| 46 | * https://github.com/krakenjs/swaggerize-express
|
| 47 | * https://github.com/jshttp/http-errors
|