2024-10-30 22:38:29 +00:00
|
|
|
# TrailBase Admin Dashboard UI
|
|
|
|
|
|
2024-11-16 20:27:09 +00:00
|
|
|
This directory contains TrailBase's admin dashboard UI. It is an SPA, i.e. it's
|
|
|
|
|
static content embedded into the TrailBase binary that executes in the browser
|
|
|
|
|
using TrailBase's privileged admin APIs.
|
2024-10-30 22:38:29 +00:00
|
|
|
|
2024-11-16 20:27:09 +00:00
|
|
|
For development one case use the vite dev-server with hot module reload. First
|
|
|
|
|
start the TrailBase binary in dev mode (permissive CORS and cookie policies):
|
2024-10-30 22:38:29 +00:00
|
|
|
|
2024-11-16 20:27:09 +00:00
|
|
|
```bash
|
|
|
|
|
$ cargo run -- --data-dir client/testfixture run --dev
|
|
|
|
|
```
|
2024-10-30 22:38:29 +00:00
|
|
|
|
2024-11-16 20:27:09 +00:00
|
|
|
and then vite:
|
2024-10-30 22:38:29 +00:00
|
|
|
|
2024-11-16 20:27:09 +00:00
|
|
|
```bash
|
|
|
|
|
$ pnpm run dev
|
|
|
|
|
```
|
2024-10-30 22:38:29 +00:00
|
|
|
|
2024-11-16 20:27:09 +00:00
|
|
|
## Protobuf codegen
|
2024-10-30 22:38:29 +00:00
|
|
|
|
2024-11-16 20:27:09 +00:00
|
|
|
We're using [ts-proto](https://github.com/stephenh/ts-proto#usage) for
|
|
|
|
|
protobuf code generation. Run
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
$ pnpm run proto
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
, which requires the following system dependencies:
|
|
|
|
|
|
2025-02-27 12:28:11 +00:00
|
|
|
- **protoc**, e.g. via the `protobuf-compiler` Debian/Ubuntu package
|
|
|
|
|
- **descriptor.proto**, e.g. via the `libprotobuf-dev` Debian/Ubuntu package.
|
2024-11-16 20:27:09 +00:00
|
|
|
|
|
|
|
|
## Rust-TypeScript codegen
|
|
|
|
|
|
|
|
|
|
The TypeScript bindings for the admin APIs are checked into the repository
|
2025-08-06 17:01:36 +00:00
|
|
|
under `/crates/assets/js/bindings`.
|
2025-06-03 12:40:07 +00:00
|
|
|
They're generated via `ts-rs` and written every time the Rust tests execute,
|
|
|
|
|
i.e. `cargo test`. They're checked in to avoid having Rust depend on
|
|
|
|
|
TypesScript and TypeScript depend on Rust tests.
|
