kantedal/esh-elva-bot

ELVA - Linlöpings Virtual Assistant

• TypeScript 2.4 to ES6 transpilation,
• TSLint 5.x with Microsoft recommended rules,
• Jest unit testing and code coverage,
• Type definitions for Node.js v6.x (LTS) and Jest,
• NPM scripts for common operations,
• a simple example of TypeScript code and unit test,
• .editorconfig for consistent file format.

Quick start

This project is intended to be used with latest LTS release of Node.js or later and NPM. Make sure you have those installed. Then just type following commands:

git clone ...
cd esh-elva-bot
npm install

Set environment variables

cp .env.example .env

...and set API keys. Then:

npm run watch && npm run dev

Deploy

We merge the master branch to the deploy branch and have a Heroku hook that builds

Available scripts

• clean - remove coverage data, Jest cache and transpiled files,
• build - transpile TypeScript to ES6,
• watch - interactive watch mode to automatically transpile source files,
• lint - lint source files and tests,
• test - run tests,
• test:watch - interactive watch mode to automatically re-run tests