Technical Setup Quickstart

Quick Start

The simplest way to get up and running is via Docker, see the Docker Section for more information

Development Getting Started

Since there are multiple parts required to get started with development, which can be daunting at first look, a simple script has been created to speed up this process

Running this for the first time will do the following

1. Confirm all prerequisites are met
2. Create a new database running in Docker
3. Run database migrations, and populate with required data
4. Setup the api
5. Setup the frontend
6. Create simple startup scripts
7. Optionally start everything

Prerequisites

The following prerequisites must be installed before running the script git, go, node, npm, docker, docker-compose, mysqlsh, goose

Installing docker

Full Guide https://docs.docker.com/install/linux/docker-ce/ubuntu/

Installing goose

1. go get -u github.com/pressly/goose/cmd/goose
2. Make sure $GOPATH/bin is on your $PATH!

Full Guide https://github.com/pressly/goose#install

Installing mysqlsh

1. Download https://dev.mysql.com/downloads/file/?id=487007
2. sudo dpkg -i mysql-apt-config_0.8.13-1_all.deb
3. sudo apt-get update
4. sudo apt-get install mysql-shell

Full Guide https://docs.oracle.com/cd/E17952_01/mysql-5.7-en/installing-mysql-shell-linux-quick.html