Simple assistant for daily tasks. Written for Node.js
  • JavaScript 100%
Find a file
2021-02-16 01:02:17 +01:00
src Small fixes. Modify README. 2021-02-16 01:02:17 +01:00
tests Small fixes. Modify README. 2021-02-16 01:02:17 +01:00
.gitignore Jest config file. Tests added. 2021-01-12 01:07:31 +01:00
jest.config.js Jest config file. Tests added. 2021-01-12 01:07:31 +01:00
LICENSE First version 2020-11-09 23:46:00 +01:00
package-lock.json Jest config file. Tests added. 2021-01-12 01:07:31 +01:00
package.json Jest config file. Tests added. 2021-01-12 01:07:31 +01:00
README.md Small fixes. Modify README. 2021-02-16 01:02:17 +01:00

Palathea

Palathea is a simple assistant for daily tasks. Built in Node.js and designed to be easy to use, implement and work with.

Building, Testing and Installation

This is a Node.js module available through the GitHub registry.

Before installing, download and install Node.js, Node.js 12.0 or higher required.

If this is a brand new project, make sure to create a package.json first with the npm init command.

Installation is done using the npm install command:

npm install @abnazhor/palathea

Features

  • Easy to use and implement
  • Custom dictionaries, handlers and intents
  • Very fast response times
  • Uses JSON files to configure basic utilities

Examples

const Assistant = require("@abnazhor/palathea");

const dictionary = require("my_dictionary.json");
const handlers = require("my_handlers.json");
const intents = require("my_intents.json");

const palathea = new Assistant(intents, dictionary, handlers);

// Returns response as a string.
await palathea.reply("This is my phrase");

Tests

To run the test suite, first install the dependencies, then run npm test:

npm install
npm test

License

GNU GPLv3