connor-baer / lunchup

🤖 A Slackbot to match coworkers for blind lunches

LunchUp

A Slackbot to match coworkers for blind lunches

• Built on the Slack Node SDK
• Written in ES2017
• Tests with Jest

Getting started

❯ git clone https://github.com/connor-baer/lunchup.git
❯ npm install
❯ npm start

The server is started with the --inspect flag by default, so you can debug Node.js with the Chrome DevTools.

Testing

Linting

We use prettier and ESLint with the Airbnb config to lint our JavaScript. ESLint is configured so that any formatting rules covered by prettier are reported by prettier. Any Airbnb rules covered by prettier are overwritten with the prettier setting.

The project has a linting task with an additional watch mode:

• test:lint: runs ESLint on **/*.js.
• test:lint:watch runs the above lint task in watch mode. Only changed files are linted.

Fixing

We have three npm tasks for fixing code.

# Fix JavaScript
❯ npm run fix:prettier
❯ npm run fix:eslint

# Fix all
❯ npm run fix

Testing

We use Jest to unit test our JavaScript.

The project has a testing task with an additional watch mode:

• test:unit: runs Jest on src/**/*.js.
• test:unit:watch runs the above test task in watch mode. Only changed files are tested.

Run all

# Test all
❯ npm run test