Toolset to create, test & deploy Tasks for RALLF (NodeJS Edition)
[](https://circleci.com/gh/RobotUnion/rallf-js-sdk)
[](https://www.npmjs.com/package/rallf-js-sdk)
[![Dependencies][npm-deps-img]][github-link]
[]()
[![License][license-img]][github-link]
[![Website][rallf-status-img]][rallf-link]
[![wiki][wiki-img]][wiki-link]
[`🔗 Getting Started`][docs:GettingStarted]
[`🔗 Creating`][docs:Creating]
[`🔗 Running`][docs:Running]
[`🔗 CLI`][docs:cli]
[`🔗 Manifest`][docs:manifest]
[`🔗 Skill`][docs:Skill]
[`🔗 Task`][docs:Task]
****
## Resources
* [Installing](#installing)
* [Getting Started](#getting-started)
* [Wiki](https://github.com/RobotUnion/rallf-sdk/wiki)
* [Examples](examples)
## Installing
To have access to global [commands][docs:cli], run:
```zsh
$ npm install rallf-js-sdk -g
```
For using for development, run inside your task project:
```zsh
$ npm install rallf-js-sdk
```
## Getting Started
Now you can check the [Getting Started][docs:GettingStarted] guide to start developing 🤖!
## Overview
```js
const rallf = require('rallf-js-sdk');
class MyTask extends rallf.Task {
constructor() {
super();
this.firefox = null;
}
async warmup() {
this.logger.debug('warmup');
this.firefox = await this.devices.get('firefox');
await this.firefox.get('https://github.com');
}
async start(input) {
this.logger.debug(this.fqtn + ' started');
return await this.firefox.getTitle();
}
async cooldown() {
this.logger.debug('cooldown');
await this.firefox.quit();
}
}
```
## Found a bug?
If you found a bug please leave us an issue.
* Make sure you check the [contributing guidelines](https://github.com/RobotUnion/rallf-js-sdk/blob/master/.github/CONTRIBUTING.md) before.
* Make sure that issue has not been reported
## Want to collaborate?
We love contributions from people, refer to the [contributing guidelines](https://github.com/RobotUnion/rallf-js-sdk/blob/master/.github/CONTRIBUTING.md) for information on how to get started and how we work. Also and don't hesitate in contacting us.
