From aeebe72ae8a1877aba57bd31158aecec700c6fdd Mon Sep 17 00:00:00 2001 From: Darren Clarke Date: Mon, 7 Oct 2024 15:49:29 +0200 Subject: [PATCH] Update readme 2 --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index e3f1898..398c869 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,16 @@ Key differences between CDR Link and a standard Zammad installation: - In addition to the full Zammad interface, CDR Link also provides a simplified 'shell' interface that focuses on the most-commonly-used functionality. - Additional channels to communicate with users, including Signal, Whatsapp & Twilio voice messaging. - More stringent privacy defaults: ticket data is never sent over email and calls to third-party services are restricted. + +## Developing + +This is a monorepo that contains CDR Link and several supporting applications and libraries. It also includes Dockerfiles to build all of the other containers required for an installation. By tagging our own versions of these dependencies, we can make sure that different versions of the supporting containers all work together and are updated in sync. + +We use [Turborepo](https://turbo.build) to manage development and building of the packages. To get started: + +- `npm install` in the root directory +- `turbo build` to build all packages + +To run a single package: + +- `turbo dev --filter @link-stack/link`