BoolJS API is a BoolJS module designed to define the API that is implemented in the framework bootstrapping. Here you can find the available plugins and base classes that make part of an instance.

Here's also located the logic of application instances and stores.

API Core comes as a dependency of BoolJS, so —in normal circumstances, there should be no need of installing it as a separate dependency.

If you need to install it as a part of a plugin, run the command

$ npm install @booljs/api@latest --save-peer

You'll probably need to use API when building a plugin. In that case, you can call the necessary classes requiring @booljs/api. For instance:

'use strict';

const { RouteMiddleware } = require('@booljs/api');

module.exports class MyMiddleware extends RouteMiddleware {
    // ...
};

We're still making -or looking for- a serious contributing document. By now, feel free to contribute the way you usually do in other projects. If this is your first time, follow these steps:

1. Fork us
2. Make your changes
3. Commit by each file change, indicating what you did in that file.
4. Please –¡please!-, don't push until you get the tests completely passing (in this case is just once).
5. Push and make a pull request, describing what you did in general.
6. PR will go through an automated revision in Travis CI. If everything is correct, a peer-revision will start.