Okuna.js (beta) - A library for Node.js and the browser to connect to the Okuna API.

This library is currently in public beta, so errors might appear here and there. If you've stumbled upon an error, please report it in the library's issue tracker.

Table of Contents

• Requirements
• Installation
• Documentation
• Contributing
  • Code of Conduct
  • License
  • Other issues
  • Git commit message conventions
• Getting Started

Requirements

• Node.js (>=8.x is recommended)
• okuna-api for local development

Installation

You can install the library using npm:

npm i okuna

or Yarn:

yarn add okuna

Documentation

You can read the library documentation here.

Contributing

There are many different ways to contribute to the project's development, just find the one that best fits with your skills and open an issue/pull request in the repository.

Examples of contributions we love include:

• Code patches
• Bug reports
• Patch reviews

Code of Conduct

Please read and follow our Code of Conduct.

License

Every contribution accepted is licensed under MIT or any later version. You must be careful to not include any code that can not be licensed under this license.

Please read carefully our license and ask us if you have any questions.

Responsible disclosure

Cyber-hero? Check out our Vulnerability Disclosure page.

Other issues

We're available almost 24/7 in the Okuna slack channel. Join us!

Git commit message conventions

Help us keep the repository history consistent 🙏!

We use gitmoji as our git message convention.

If you're using git in your command line, you can download the handy tool gitmoji-cli.

Getting Started

Clone the repository:

git clone [email protected]:jozsefsallai/okuna.js.git
cd okuna.js

Install the dependencies:

npm install

To run a development build:

npm run watch

To make a single build of the files:

npm run build

To build for both Node and the browser, run:

npm run prepare

Make sure that your changes pass linting:

npm run lint

...and that your tests are okay:

npm run test

Happy coding 🎉!