admin-utility v1.0.2

Data Access Layer

Data Access layer

Documentation

Documentation is written in DOCS.MD

Commands

Install

npm install

Build

npm run build

This command will run first linting and testing and then builds a project

Test

npm test

Code coverage report will be created inside the project root in coverage folder.

You can open the report

google-chrome ./coverage/lcov-report/index.html

Or whatever browser you use

Test on watch mode

npm run test-watch

Lint code

npm run lint

Generate documentation

npm run document-code

Used technologies:

1. Typescript - project is written and compiled using this awesome language
2. Jest.js - test framework
3. tslint - linting library
4. prettier - Awesome code formatter
5. Typedoc - documentation generator for Typescript
6. Editorconfig - keeps consistent configuration across various editors and IDEs