peterbecich / bannodemo

Banno Demo

Twitter firehose data

FS2 0.10.0-M10 Scaladoc

FS2 0.10.0-M11 Scaladoc

---

Quick Start

Docker Compose is required. If building the Docker Image from source, be sure to also clone the sub-module in this repository, as Docker will copy its contents into the Image when building.

1. Create a Twitter App
2. Create a file BannoDemo/ops/.env. Docker Compose will read this file for its environmental variables
3. Copy this template and the corresponding credentials from your Twitter App into the file .env:

TWITTER_CONSUMER_TOKEN_KEY=
TWITTER_CONSUMER_TOKEN_SECRET=
TWITTER_ACCESS_TOKEN_KEY=
TWITTER_ACCESS_TOKEN_SECRET=

4. Proceed with either a pre-built Docker Image, or build the image from source

Start from Pre-built Docker Image

1. Pull the Docker image from Docker Hub: peterbecich/bannodemo or peterbecich/bannodemo-arm64

2. Proceed to start the Compose application

(or) Build from Source

SBT is required.

1. Start SBT in BannoDemo/
2. Run test in SBT
3. Run docker in SBT to produce the Docker image peterbecich/bannodemo:latest
4. Exit SBT
5. Proceed to start the Compose application

Start Docker Compose

1. Change directory to BannoDemo/ops/
2. Run docker-compose up to start the demonstration and log to the terminal, or docker-compose up -d to start the demonstration and detach
3. Visit http://localhost/stats
4. If detached, run docker-compose down to stop the Compose application