From 69e6375f3877b9005cda51e9b2df22ca4c3637a6 Mon Sep 17 00:00:00 2001 From: "Rene V. Vergara" Date: Sat, 23 Dec 2023 22:17:09 -0500 Subject: [PATCH] api-srvr: README update --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bb5d192..2976902 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,23 @@ -# Basic API server (Node.js + TypeScript) +# Basic API server (Node.js + Express.js and TypeScript) ## Abstract -A basic functional template for creating an API server using Node.js and TypeScript. +A basic functional template for creating an API server using Node.js + Express.js and TypeScript. + +## Test + +The template is functional and you can test it using HTTPie, curl or Postman. + +### Start the API server + +npm run dev + + +HTTPie + +http localhost:3000/ => returns "Main page loaded" +http localhost:3000/data => returns + +... + +...