feat: rust cli

bbortt · Mar 10, 2024 · 5c054cd · 5c054cd
1 parent 4fa4f7f
commit 5c054cd
Show file tree

Hide file tree

Showing 14 changed files with 1,624 additions and 25 deletions.
diff --git a/.idea/DigmaJCEFProjectPersistence.xml b/.idea/DigmaJCEFProjectPersistence.xml
diff --git a/.idea/gradle.xml b/.idea/gradle.xml
diff --git a/.idea/runConfigurations/k6_report_ingress.xml b/.idea/runConfigurations/k6_report_ingress.xml
diff --git a/README.md b/README.md
@@ -1,8 +1,23 @@
 # K6 Dashboard
 
-## Uploading Reports
+## Prerequisites (for development)
 
-Get started by running `docker compose -f dev/docker-compose.yml up -d` from within the root of this repository.
+If you're not interested in participating and just want to see it working, skip to
+the [quickstart section](#quickstart).
+
+You'll require...
+
+- [OpenJDK 21](https://adoptium.net/temurin/releases/) for [`apps`](./apps)
+- [Rust](https://www.rust-lang.org/tools/install) for the [`cli`](./cli)
+
+### Database
+
+First, set up the PostgreSQL database contained in [`dev/docker-compose.yml`](./dev/docker-compose.yaml). Once it's up
+and running, apply all database migrations using `./gradlew :apps:k6-report-ingress:flywayMigrate`.
+
+## Quickstart
+
+Get started by running `docker compose -f dev/docker-compose.yaml up -d` from within the root of this repository.
 
 This will start a [TimescaleDB](https://www.timescale.com/), run the [contained k6 test](./src/test/k6/script.js) and
 export the resulting data into the database.

diff --git a/cli/.gitignore b/cli/.gitignore
@@ -0,0 +1,2 @@
+client/
+target/