From 1cd6b3afcd244e01b8c8f4a91905b1a67cc24302 Mon Sep 17 00:00:00 2001 From: Era Dorta Date: Thu, 4 Sep 2025 22:16:47 +0100 Subject: [PATCH] Simplify dev environment setup instructions --- CONTRIBUTING.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 042b96b..736cf22 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,24 +4,26 @@ Contributions are welcome, including bug reports, implementing features or writi ## Dev Environment Setup -The recommended way is: +The recommended way is to use docker compose: -1. Build the docker image, setting the version to a number of your choosing +1. In the `docker-compose.yml` replace the `image: bbernhard/signal-cli-rest-api:latest` for `build: "."` + +The development workflow is: + +1. Make changes in the source code. +2. Build the image and run a container. ```bash - docker build --network=host --tag bbernhard/signal-cli-rest-api: . + docker compose build ``` -2. Adjust the `docker-compose.yml` - * Replace the `image: bbernhard/signal-cli-rest-api:latest` for `image: bbernhard/signal-cli-rest-api:` - * Add the version to the environment: - ```yml - environment: - - BUILD_VERSION= - ``` -3. Run the image ```bash docker compose up ``` -4. Make code changes and repeat steps 1 to 3 +3. Test the changes. +4. Bring the container down. + ```bash + docker compose down + ``` +4. Repeat as many times as needed. ## Building the documentation