MBO API Client

The API Client for the MBO API written in TypeScript.

Install

yarn add @teamexos/mbo-api

Testing

yarn test

Linting

yarn lint:fix

Local Development

install nix

https://nixos.org/guides/install-nix.html

run nix-shell from the root directory of the project

How to publish a new package version

Create a github tag with a name corresponding to the new package version (e.g. 1.2.3) from package.json. The package will be published to the npm registry using github actions.

WebStorm Settings

Follow these steps:

1. Open Settings/Preferences
2. Languages and Frameworks
3. JavaScript
4. Code Quality Tools
5. ESLint
6. Select the "Automatic ESLint configuration" option
7. Select the "Run eslint --fix on save" option

Recommended VSCode Settings

Open VSCode, and install the extension "Prettier - Code Format".

Create a file at:

.vscode/settings.json

Open and add the following:

{
  "editor.formatOnSave": false,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "[javascript]": {
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[typescript]": {
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  }
}