Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 1.81 KB

Readme.md

File metadata and controls

46 lines (29 loc) · 1.81 KB
Raw

Systek Social Lunch Bot

How to spin up in development

This application relies on both the backend service and mongodb instance running. You therefore need Docker to spin up both containers. Click here to install Docker Desktop if you haven't already.

Setting up the development environment

In order for VS Code or other editors to run linting or misc code helpers correctly, you my need to install the npm modules.

To install npm modules:

  1. In the projects local folder, run: yarn install
  2. Find the application running at localhost:4000

To set up tokens

Note for Slack token: Do not use the production Systek Workspace token when you're running this bot locally for development. This will start sending out new batches of invites to live users! 😱 Instead, create your own Slack Workspace (or ask to get invited to the Systek Experiments Workspace) to an existing Systek Beta Workspace where you can safely test the bot.

The slack token is added in a separate env file, which you have to create yourself BEFORE continuing to the next step of spinning up containers.

  1. Create the env file env/secrets.env
  2. Add the the environment strings as shown below. Actual tokens or values can be found in internal documentation.
  3. Note that this env file is ignored by git (see .gitignore)

Secrets.env contents:

APP_SLACK_TOKEN="your-token-here"
APP_ADMIN_REST_TOKEN="your-secret-here"
APP_EVENT_MEET_URL="https://meet.google.com/(google-meet-code-here)"

Running the application locally

  1. In the project root folder, run: docker-compose -f docker-compose.dev.yml up.
  2. Find the application running at localhost:4001

Make sure that you don't have conficting services running on the same ports.

Tunneling your local running instance for outside access

(Details to come)