Updated readme
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
Sambo Chea 2021-09-14 11:07:08 +07:00
parent a00c5b0650
commit 744c6585bb

View File

@ -12,6 +12,18 @@
# Quickstart
- Clone repository
```shell
git clone https://git.cubetiqs.com/CUBETIQ/express-nodejs-app.git --recurse-submodules --remote-submodules
```
- Install
```shell
yarn
```
- Start
```shell
@ -91,6 +103,20 @@ import HomeController from "./home.controller"
export const controllers = [IndexController, PersonController, HomeController]
```
- Output registered routes
```ts
┌─────────┬──────────────────────┬─────────────────────────────────┐
│ (index) │ api │ handler │
├─────────┼──────────────────────┼─────────────────────────────────┤
│ 0 │ 'GET /hello' │ 'IndexController.index' │
│ 1 │ 'GET /hello/:name' │ 'IndexController.hello' │
│ 2 │ 'GET /person' │ 'PersonController.getPersons' │
│ 3 │ 'POST /person' │ 'PersonController.createPerson' │
│ 4 │ 'DELETE /person/:id' │ 'PersonController.deletePerson' │
└─────────┴──────────────────────┴─────────────────────────────────┘
```
### Contributors
- Sambo Chea <sombochea@cubetiqs.com>