From fc2bdeea819a5a76ca017c7437946a490df899da Mon Sep 17 00:00:00 2001 From: Andy Ford Date: Wed, 18 Oct 2023 17:48:52 +0100 Subject: [PATCH] docs: readme --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d2b6804..89250ef 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,24 @@ # ECFMP Discord -ECFMP Discord Service +ECFMP Discord Service. This service is responsible for interacting with ECFMP's Discord server in order to be notify flow managers of flow measure updates. -# Developing Locally +# Local Development A docker-compose file is provided for development convenience. ## Before You Start Before you start the containers, make sure you run `make protobuf`. This will generate the protobuf files that this -service requires. +service requires for other services to communicate with this. + +Copy the `.env.dev.example` file to `.env` and set the bot token. This bot should be allowed to access the channel that you intend to publish +messages onto. + +## Devcontainer + +A devcontainer setup is provided for development. ## Running Tests -Tests can be run using `make test`, which will run the tests in the `go_testing` container, allowing it to access -MongoDB. +Tests can be run using `make test`, which will run the tests in the main container. If you're in the dev container, you can run the tests +by running `go test -v ./...`.