vvgo

Virtual Video Game Orchestra

👋 We are the Virtual Video Game Orchestra (VVGO for short), an orchestra organized by members from various IRL VGOs/GSOs, and comprised of local musicians hailing from across the globe!

Changing HTML pages

HTML pages are generated from go templates. These are affectionately reffered to as views. Views, along with all public files are found in here.

If you change a view, you will most likely need to update a test as well. Test views can be found here. The tests are used to ensure the views are rendered properly before the site can be deployed.

Run VVGO locally

1. Install build tools

In order to build, test, and run the vvgo webapp, you will need to install git, docker, yarn, and golang. Below are links to installation docs for each service:

Git

• A version control system that we use to tracks changes to the source code.
• Installers: Windows | Mac | Linux

Docker

• A container engine that we use to download and run service dependencies for the webapp.
• Installers: Windows | Mac | Linux

Yarn

• Manages and downloads the javascript dependencies.
• Installers: Windows | Mac | Linux

Golang 1.14

• Builds and compiles the source code.
• Installers: All

2. Clone the git repo

Clone the git repo and change to the source code directory. Launch GitBash or your favorite terminal, and run this command:

git clone https://github.com/virtual-vgo/vvgo.git && cd vvgo

2. Launch runtime services

Redis and Minio are runtime dependencies for the webapp. If the webapp cannot connect to Redis and Minio at startup, it will complain and exit. These service can be started using the docker-compose command:

docker-compose up -d

3. Download javascript dependencies

yarn install

4. Build and run the app!

go generate ./... && go build -v -o vvgo ./cmd/vvgo && ./vvgo