Skip to content

Commit

Permalink
Update instructions for local building
Browse files Browse the repository at this point in the history
  • Loading branch information
stanch authored Oct 4, 2024
1 parent 58bf502 commit e8766d0
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]:snowplow-incubator/snowplow-micro.git
Expand All @@ -26,10 +28,23 @@ cd snowplow-micro
git clone --branch 3.2.0 --depth 1 [email protected]: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.
Expand Down Expand Up @@ -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/

0 comments on commit e8766d0

Please sign in to comment.