dothemath.app backend

Table of Contents

• Prerequisites
• Installation
• Configuration
• Slack app permissions
  • Bot token scopes
  • User token scopes
• Running locally
• Building for production
• API documentation

Prerequisites

• Node.js 14.x
• Yarn >=1.22.4 <2

Installation

Clone the repo
git clone https://github.com/dothemath-se/dothemath-app-backend.git

Install dependencies
yarn

Running locally

Compile, start the local web server on port 3000, and recompile on changes
yarn dev

Building for production

Compile TypeScript files into dist/ folder
yarn build

Configuration

These environment variables need to be set for the user running the code. (This applies on a server as well as locally.)

• SLACK_SIGNING_SECRET
• SLACK_BOT_TOKEN
• SLACK_USER_TOKEN

The values can be found on the config pages for the slack app.

Slack app permissions

These permissions need to be enabled on your Slack app:

Bot token scopes

• channels:history
• chat:write
• chat:write.customize
• users:read

User token scopes

• files:write

API documentation

API documentation