README.md

Scope Serverless Backend

The backend of the status-board is driven by 3 lambda functions exposed through API Gateway with the http event

Watch the Backend Video Tutorials then the Front-end Video Tutorials

Table of Contents

Click to expand

• Configuration
• Setup

Configuration

1. Duplicate config.prod.example.json into a file named config.prod.json and fill in your repositories values.

{
  "projectName": "tester",
  "region": "us-west-2",
  "REPO": "username/repoName",
  "GITHUB_WEBHOOK_SECRET": "xxxxx",
  "GITHUB_API_TOKEN": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "GITHUB_USERNAME": "YourGithubUserName"
}

2. You will also need to update ADD_YOUR_REPO_NAME_HERE in the serverless.yml file.

custom:
  repoName: ADD_YOUR_REPO_NAME_HERE

Example:

custom:
  repoName: serverless

Setup

After you added your values to the newly created config.prod.json file, you are ready to deploy!

0. Run npm install to install the dependancies

1. Run serverless deploy and wait for the stack to be created

Watch the Backend configuration video

2. Copy the API urls to use in the frontend portion of the application

3. Populate the initial data for your status board with

serverless invoke -f setup

This will pull in the open issues from your repository for the initial data. This only needs to be run once.

4. Setup your github webhook in your repositories settings

Watch the webhook setup video

5. Plug in your API endpoints to the front-end application

To get those API endpoints again type:

serverless info

Head over into ../frontend/src/custom.config.js and plugin the API endpoints

Watch the front-end setup video

6. (optional) You can seed your initial issues/prs by running

sls invoke -f setup

---

Website • Email Updates • Gitter • Forum • Meetups • Twitter • Facebook • Contact Us