summaryrefslogtreecommitdiff
path: root/README.md
blob: 80cd59d1b9460af6991e955601ee23aa8c3f9937 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# SNOW
Super Nifty Olo Webapp - a tool for Platform Evolution engineers

## Configuring
Some configuration is need on your laptop to make SNOW work.

### Environment Variables
Add these to your .bashrc:
`export OLO_PROJECT_HOME=~/jobs/olo/projects  # or wherever you keep your Olo git checkouts
export OLO_AWS_BUILD_PROFILE=build  # or whatever you call your AWS build profile`

### AWS
As long as your `~/.aws` directory is in order you should be good to
go. Make sure you have a valid SSO session.

### tfcloud
As long as your `~/.terraform.d` directory is in order you should be
good to go. Make sure you are logged into tfcloud.

### github-cli
Both the docker build and the app itself rely on a working github-cli.

## Building and Running
- Navigate to the `ci` top-level directory in a shell.
- Copy `docker-compose.yaml.example` to `docker-compose.yaml` and
  customize the bind paths as necessary.
- Run `./docker-build.sh`
- Run `./docker-run.sh`
- Open a web browser and navigate to `http://localhost:3013`. The app
  takes a bit of time to initialize, so keep trying if it doesn't load
  immediately.