record a sound

Setup

Set Env Vars

Setup DB migration environment settings by copying config/config_example.json => config/config.json

cp config/config_example.json config/config.json

Fill in the appropriate DB info in config/config.json

Run DB migrations

Next, run the migrations:

npm run migrate

Development

Ideal development setup is in a docker container. First install Docker and Docker-Compose.

Next, the development environment can most easily be initialized via Make files. If the development environment can execute Make files, try the following:

sudo make dev

To install npm dependencies, open a terminal connected to the running docker orchestration via:

sudo make bash

Test Image

• npm run image:build
• start the image with either of the folowing:
  • npm run image:start
  • npm run image:bash - to start the container and provide a command line

Deploy

1. Ensure that docker is available on the command line

• if docker install is needed, will also need to create new private repo creds (hub.docker.com) and register these with the local docker cli

2. Commit all changes
3. npm run publish:test|patch|minor|major

• This will build, tag, and publish the latest image.
• Take note of the new image tag name. e.g. The tag from the following output is v2.0.3-10.

v2.0.3-10: digest: sha256:44587ec99bc610dbfc1019da6b486c110eea8275f01eb40176e67187c36c0092 size: 952

4. Verify image has been promoted to Docker Hub

5. Perform k8s rollout via instructions in deployment repo

Docs

• Project Overview
• Project Configuration
• Package Script Commands

Contributors

Thanks goes to these wonderful people (emoji key):

Dean Slama Jr 💻	Andrés Calabrese 💻	Andrey Luiz 💻	Alin Porumb 💻	Benjamin Kniffler 💻	Birkir Rafn Guðjónsson 💬 🐛 💻 👀	Carson Perrotti 💬 💻 📖 👀
Christian Glombek 🐛 💻	Christoph Werner 💬 🐛 💻 👀	David Edmondson 💻	Dion Dirza 💬 🐛 💻 📖 👀	Evgeny Boxer 🐛 💻	Joe Kohlmann 🐛 💻	Lucian Lature 🐛 💻 👀
Mark Shlick 💻	Ryan Lindskog 💻	Steven Enten 💬 🐛 💻 👀	Sean Matheson 💬 🐛 💻 📖 💡 👀 ⚠️ 🔧	Steven Truesdell 💬 🐛 💻 📖 ⚠️	Thomas Leitgeb 🐛 💻	Tyler Nieman 💻

This project follows the all-contributors specification. Contributions of any kind welcome!