Backend

Github

All our code is hosted in github, if you don’t have a github account you can sign up.

You will then need to setup an ssh key with github, they have a guide to do that here.

In order to pull down our docker dev environment you will need to setup a github personal access token. Github has a guide for that here.

Only enable the permissions that we need.

  • repo (because there is no specific read for private repos)

  • read:packages to pull devkit images down

Once you have the token, you can add it to your systems' env.

export GITHUB_TOKEN=<your_token_here>

Docker

We have a docker dev environment that contains all the dependencies you need to begin coding. The containers are hosted in github here.

  • To login to the github container registry, run this command

    • echo $GITHUB_TOKEN | docker login ghcr.io -u <your_github_username> --password-stdin

    • This should be cached to your keychain so you should not have to do it again

Install Go

You can install go here or use brew install go if you are on mac and want an easy install.

There are a couple of commands we need to run to get go to be able to pull down our private repos.

  • go env -w GOPRIVATE="github.com/floatme-corp/*" to give go access to our private git repositories

  • git config --global url."git@github.com:".insteadOf "https://github.com/" because go uses https instead of ssh for connecting to those repositories

Install Terraform (optional)

The devkit will handle most of your terraform needs, but if your editor needs it, you can get it here or run brew install terraform.