-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
12 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 ./...`. |