Skip to content

Commit

Permalink
add development information
Browse files Browse the repository at this point in the history
  • Loading branch information
rvhonorato committed Feb 10, 2024
1 parent 1ca0a59 commit df114b8
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,3 +85,20 @@ It might make sense to configure a cron job to run this command periodically.
## Running with -f will post to Slack even if there is no ❌ in the checks
0 8,12,16,20 * * * SLACK_HOOK_URL=<your-slack-hook-url> monitor -f configuration.yaml
```
## Development
There is a `.devcontainer` configuration for VSCode, so you can use it to develop the project. It will setup a development environment and also configure a SSH server to test the checks that require a remote server.
Once inside the dev-container you can tweak the `conf/conf.dev.yaml` file to your needs and run the project with:
```
SLACK_HOOK_URL="" cargo run -- -p conf/conf.dev.yaml
```
Test it with:
```
cargo test
```

0 comments on commit df114b8

Please sign in to comment.