From e8766d02b40fe1462cecc79fbcb992e93a3f3af1 Mon Sep 17 00:00:00 2001 From: Nick Date: Fri, 4 Oct 2024 10:54:26 +0100 Subject: [PATCH] Update instructions for local building --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0ef4d5d..39f2bb9 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,9 @@ Learn more in the documentation: https://docs.snowplow.io/docs/getting-started-w ## Maintainer quick start -Assuming [Git][git] and [sbt][sbt]: +First, install [Git][git], [sbt][sbt] and [npm][npm]. + +Then clone the repository and publish the Collector dependency locally: ```text git clone git@github.com:snowplow-incubator/snowplow-micro.git @@ -26,10 +28,23 @@ cd snowplow-micro git clone --branch 3.2.0 --depth 1 git@github.com:snowplow/stream-collector.git cd stream-collector sbt +publishLocal && cd .. +``` +To run the tests: + +``` sbt test ``` +To build a Docker image for local testing: +``` +cd ui +npm build && cd .. +sbt docker:publishLocal +``` + +Note the Docker image name in the output. + ## Copyright and License Copyright (c) 2019-present Snowplow Analytics Ltd. All rights reserved. @@ -74,3 +89,4 @@ Licensed under the [Snowplow Limited Use License Agreement][license]. _(If you a [git]: https://git-scm.com/ [sbt]: https://www.scala-sbt.org/ +[npm]: https://www.npmjs.com/