Skip to content

Sheikhharis50/booking-api

Repository files navigation

Booking API

Description

The API is written using NestJS framework.

Components

Sqlite - database with typeorm is used to manage the data.

Jest - is used as a testing framework to write end-to-end test cases.

Prettier - is used to lint the code properly.

Modules

The followings are the main modules of this Project.

Agent - a entity who can login and manage the system.

User - a entity who can login into system.

Role - each Agent has a role either Regular which can read or Admin which can read and write.

Permission - each Role has many permissions against each module with read and write type.

Bookings A entity which can be created by agent against a specific user.

Quick Start

Installation

yarn install

Running the app

yarn start

Test

# e2e tests
yarn test:e2e

Stay in touch

Author - Sheikh Haris Zahid