2.3 KiB
TrailBase
A blazingly fast, single-file, and open-source application-base built on top of Rust and SQLite (libsql). It ships with type-safe restful APIs, an authentication system, an admin dashboard and more out of the box.
For more context, documentation, and an online live demo, check out our website trailbase.io. Questions? Thoughts? Check out the FAQ on our website or reach out.
Project Structure & Releases
This repository contains all components that make up TrailBase including client libraries, tests, documentation and examples. Only the benchmarks are kept separately due to their external dependencies.
Packages and pre-built binaries are available via:
Pre-built static binaries are also available as
GitHub releases.
At the moment that is builds for Linux x86_64 only until we get our
cross-platform build infrastructure set up.
In the meantime, you can use docker or try building it yourself. We have built
TrailBase successfully on Mac and Apple silicone, see instructions below.
Building
If you have all the necessary dependencies (rust, nodejs, pnpm, ...) installed, you can build TrailBase simply by running:
$ git submodule update --init --recursive
$ cargo build --release
To build fully static binaries on Linux (et al):
$ RUSTFLAGS="-C target-feature=+crt-static" cargo build --target x86_64-unknown-linux-gnu --release
Alternatively, if you want a container or don't have to deal with dependencies, you can build using docker:
$ git submodule update --init --recursive
$ docker build . -t trailbase
Contributing
Contributions are very welcome 🙏. Let's talk to see how a proposal fits into the overall roadmap and avoid surprises.
License
TrailBase is free software under the terms of the AGPLv3. If you require an exception, reach out to contact@trailbase.io.