anatha-sdk v0.1.5
Anatha SDK
Installing dependencies
Before the Anatha SDK can be used, its dependecies have to be installed. To install all dependecies, use:
npm install
Build
To build the Anatha SDK, use:
npm run build
This command will produce CommonJS, UMD and ESM compatible JavaScript bundles which can then be used in other projects. Build has to be run every time the codebase is changed.
Development
To ease the development process, you can use:
npm run dev
This command will automatically rebuild the SDK every time the codebase is changed while the process is running.
Tests
Anatha SDK uses Mocha and Chai frameworks for testing purposes. To run the current set of tests, use:
npm run test
All tests are expected to pass in all conditions.
Linter
Anatha SDK uses tslint to achieve code formatting consistency across the whole codebase. To run the linter and fix code formatting issues, use:
npm run tslint
Configurations
Configurations used by the build process and the linter process are:
- rollup.config.js (Configuration for the Rollup build process)
- tsconfig.json (Configuration for the TypeScript compiler)
- tslint.json (Configuration for the Linter)
They're located in the root of the project. Modify them only if it's necessary.