Elgato_dark/trailbase
1
0
Fork 0
mirror of https://github.com/trailbaseio/trailbase synced 2026-04-21 13:37:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
trailbase/crates/assets/js/admin/README.md
Sebastian Jeltsch 7a8c31c8e9 Cleanup: move all Rust code into a crates/ directory.
2025-08-07 10:02:32 +02:00

1.2 KiB
Raw Blame History

TrailBase Admin Dashboard UI

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.

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):

$ cargo run -- --data-dir client/testfixture  run --dev

and then vite:

$ pnpm run dev

Protobuf codegen

We're using ts-proto for protobuf code generation. Run

$ pnpm run proto

, which requires the following system dependencies:

  • protoc, e.g. via the protobuf-compiler Debian/Ubuntu package
  • descriptor.proto, e.g. via the libprotobuf-dev Debian/Ubuntu package.

Rust-TypeScript codegen

The TypeScript bindings for the admin APIs are checked into the repository under /crates/assets/js/bindings. 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.