nik/signal-cli-rest-api
1
0
Fork 0
mirror of https://github.com/bbernhard/signal-cli-rest-api.git synced 2026-09-21 06:20:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Simplify dev environment setup instructions

Browse Source
This commit is contained in:
Era Dorta 2025-09-04 22:16:47 +01:00
parent 3eb3db0a9f
commit 1cd6b3afcd
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
CONTRIBUTING.md
View File

@ -4,24 +4,26 @@ Contributions are welcome, including bug reports, implementing features or writi
## Dev Environment Setup ## 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 ```bash
docker build --network=host --tag bbernhard/signal-cli-rest-api:<a dev version> . 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:<a dev version>`
* Add the version to the environment:
```yml
environment:
- BUILD_VERSION=<a dev version>
```
3. Run the image
```bash ```bash
docker compose up 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 ## Building the documentation