nik/signal-cli-rest-api
1
0
Fork 0
mirror of https://github.com/bbernhard/signal-cli-rest-api.git synced 2026-01-26 19:03:33 +00:00
Code Issues Packages Projects Releases Wiki Activity
signal-cli-rest-api/CONTRIBUTING.md
Era Dorta 1cd6b3afcd Simplify dev environment setup instructions
2025-09-04 22:16:47 +01:00

721 B
Raw Blame History

Contributing

Contributions are welcome, including bug reports, implementing features or writing documentation.

Dev Environment Setup

The recommended way is to use docker compose:

  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. 
    docker compose build

    docker compose up
  3. Test the changes.
  4. Bring the container down. 
    docker compose down
  5. Repeat as many times as needed.

Building the documentation

Follow the instructions in the docs readme page.