Create .env.yaml
file and set environment variables. Check .env-sample.yaml
to see all the possible variables.
To install dependencies and start the project, make sure your GOPATH is set, and run:
make
make start
You can use make dev
on development to reload the server automatically on file
changes.
To run this project you need to have redis installed and running, you can use the following commands to do so.
# MacOS
brew install redis
brew services start redis
# Linux
# install using your package manager
systemctl start redis
# Docker
docker run -it --rm -p 6379:6379 redis
You can use redis-cli
to interact with redis (ie. check keys and values).
Useful commands:
# Show all keys
KEYS *
# Show value for a key
GET <key>
This service uses Vault for syncing secrets to our app.
The following structure is expected:
secret/{VAULT_NAMESPACE}/{environment}/app_tokens
secret/{VAULT_NAMESPACE}/{environment}/settings
- Run
make test/ci
,make lint
, andmake e2e
before pushing changes. - Commit messages should be at most 72 characters long.
- Commit messages should start with the scope of the changes introduced by the commit.