Skip to content

Commit f512c90

Browse files
committed
Describe earthly
1 parent b226879 commit f512c90

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

CONTRIBUTE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Check out the [Roadmap](https://docs.atomicdata.dev/roadmap.html) if you want to
1515
- [Table of contents](#table-of-contents)
1616
- [Running locally](#running-locally)
1717
- [Running locally (with local development browser)](#running-locally-with-local-development-browser)
18+
- [Compilation using Earthly](#compilation-using-earthly)
1819
- [Improve local compilation speed](#improve-local-compilation-speed)
1920
- [Cross compilation](#cross-compilation)
2021
- [IDE setup (VSCode)](#ide-setup-vscode)
@@ -49,6 +50,14 @@ Clone the repo and run `cargo run` from each folder (e.g. `cli` or `server`).
4950
- Visit your `localhost` in your locally running `atomic-data-browser` instance: (e.g. `http://localhost:5173/app/show?subject=http%3A%2F%2Flocalhost`)
5051
- use `cargo watch -- cargo run` to automatically recompile `atomic-server` when you push new assets using `pmpm build-server` in `atomic-data-browser`. This can be useful if you're debugging specific features that you can't reproduce while the front-end is hosted in vite.
5152

53+
## Compilation using Earthly
54+
55+
There are `earthfile`s in `browser` and in `atomic-server`.
56+
These can be used by Earthly to build all steps, including a full docker image.
57+
58+
- Make sure `docker` is running and `earthly` is installed
59+
- `earthtly +build` in root folder
60+
5261
## Improve local compilation speed
5362

5463

0 commit comments

Comments
 (0)