Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.06 KB

Development-Guide.md

File metadata and controls

37 lines (24 loc) · 1.06 KB

Development Guide

If you are a developer and wants to develop this library, then this is for you.

Before getting started

To get started with development, You want these tools installed on your system.

And in your preferred code editor, Install these extensions/plugins. They are not required but having them installed is good.

  • TSLint
  • Prettier
  • EditorConfig

Setting Up

First you have to fork this repository. Click here to do that.

Then clone the forked repository to your machine.

Finally, run npm install inside the project folder to install all the dependencies.

Folder Structure

The folder structure is

  • docs/ - Documentation generated by TypeDoc
  • docs-manual/ - Docs written by humen
  • src/ - The main code
    • endpoints/ - Code for accessing the API's endpoints
  • test/ - Jest based tests
  • web/ - Bundled code for websites
  • dist/ - Bundled code for npm