30 lines (22 loc) · 721 Bytes

Contributing

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

Dev Environment Setup

The recommended way is to use docker compose:

In the docker-compose.yml replace the image: bbernhard/signal-cli-rest-api:latest for build: "."

The development workflow is:

Make changes in the source code.
Build the image and run a container.
```
docker compose build
```
```
docker compose up
```
Test the changes.
Bring the container down.
```
docker compose down
```
Repeat as many times as needed.

Building the documentation

Follow the instructions in the docs readme page.