rallf-js-sdk
Version:
Toolset to create Tasks for RALLF
29 lines (22 loc) • 1.19 kB
Markdown
# RALLF Task
> This project was generated with `rallf-js-sdk@<sdk_version>`
### Getting started
#### Key files
* `config/manifest.json` - The [Manifest]() holds information about your Task, e.g: name, version, fqtn
* `mocks/test.mock.js` - [Mocks]() are just the way of testing your tasks locally, without a [Incubator]()
* `robots/test-robot` - [Robots]() TODO...
* `src/main.js` - This is the main file of the task, the one that will get executed
### Docs
* [Getting Started](https://github.com/RobotUnion/rallf-sdk/wiki/Getting-Started)
* [Creating Tasks](https://github.com/RobotUnion/rallf-sdk/wiki/Creating-Tasks)
* [Running Tasks](https://github.com/RobotUnion/rallf-sdk/wiki/Running-Tasks)
* [Technical Docs](https://github.com/RobotUnion/rallf-sdk/wiki/Technical-Docs)
#### Running
* `npm start`
* `rallf-js run --task /path/to/task`
You will now if everything went OK
Now you can have fun! 🤖
## 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/v2/.github/CONTRIBUTING.md) before.
* Make sure that issue has not been reported