Skip to content

Latest commit

 

History

History
27 lines (19 loc) · 1.31 KB

README.md

File metadata and controls

27 lines (19 loc) · 1.31 KB
Raw

Eyewitness UI

User interface to allow admins to interact with their Eyewitness bot.

Dependencies

Required

  • Node.js (see the "engines" property in package.json for supported versions).
  • Npm package manager.

Optional

  • Docker 17+ (for local testing)
  • Ngrok (for local testing)
  • MongoDB (if not using Docker for local testing)

Local Development

When developing locally I like to use Docker (for environment encapsulation). I also use multiple terminal windows/tabs rather than starting all the Docker containers in one window as this makes it easier to read the application's terminal output.

Install

You first need to create a local .env file which will contain secrets and provider specific config. See ./app/main.js for the full list of environment variables and the corresponding config names. See also empty.env - this provides a starting point for creating a .env file for a specific environment.

Run

  1. Start the eyewitness bot and dependencies.
  2. Open an additional terminal tab, navigate into the folder for this project, and run docker-compose up ui.

Deploying Eyewitness

See the eyewitness repo for instructions on how to deploy.