@totentech/api-client v0.1.2

API client

Interface from the client side to an API.

Table Of Contents

• Usage
• Setup
• Deployment
• Scripts
• Built With
• Release History
• Versionning
• Authors
• License

Usage

• Add the dependency:

npm install @totentech/api-client
yarn add @totentech/api-client

Setup

• Install the dependencies:

yarn install

Deployment

• Build the project:

yarn build

• Deployed files are located in the dist repository.

Scripts

• yarn build: See Deployment.
• yarn format: Format the code, apply needed modifications.
• yarn lint: Check the code quality.
• yarn test: Test the code and generate the test coverage.
• yarn test:watch: Watch for modifications to run the tests.

Built With

Yarn | Node.js | TypeScript | Eslint | Prettier | Jest | axios

Release History

Check the CHANGELOG.md file for the release history.

Versionning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Benjamin Guibert: Creator & main contributor

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License. See the LICENSE file for details.