Skip to content

README.md

Latest commit

 

History

History
33 lines (24 loc) · 785 Bytes

README.md

File metadata and controls

33 lines (24 loc) · 785 Bytes

KMHDUI API App

Collection of API for HFG KMHDUI backend

Getting Started

Prerequisites

Make sure you have Node.js and npm installed on your system. Our server use Node js v18.16.0

Installation

  • Clone this repository:
git clone https://github.com/KMHDUI/api-hfg.git
cd api-hfg
  • Install dependencies:
npm install
  • Make .env file and fill it with desire credentials. You can check list of required credentials in .env.example file

Running the App

Start the Express.js server:

npm run dev

Open your web browser and go to http://localhost:8000. You should see your Express.js app running.

See Documentation

We use swagger for our API documentation. You can see list of available endpoint on http://localhost:8000/docs