From 744c6585bbb54df106f4b12a945cc816b02c1583 Mon Sep 17 00:00:00 2001 From: Sambo Chea Date: Tue, 14 Sep 2021 11:07:08 +0700 Subject: [PATCH] Updated readme --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 059f412..9a480d1 100644 --- a/README.md +++ b/README.md @@ -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