Skip to content

Commit

Permalink
Expand README.md and add references to packages and pre-built releases.
Browse files Browse the repository at this point in the history
  • Loading branch information
ignatz committed Oct 31, 2024
1 parent bdb3735 commit 953879c
Showing 1 changed file with 35 additions and 15 deletions.
50 changes: 35 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,53 @@
# TrailBase

A blazingly fast, single-file, and open-source server for your application with
type-safe restful APIs, auth, admin dashboard, etc.
A [blazingly](https://trailbase.io/reference/benchmarks/) 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](https://trailbase.io).
Questions? Thoughts? Check out the [FAQ](https://trailbase.io/reference/faq/)
on our website or reach out.

## FAQ
## Project Structure & Releases

Check out our [website](https://trailbase.io/reference/faq/).
This repository contains all components that make up TrailBase including client
libraries, tests, documentation and examples.
Only the [benchmarks](https://github.com/trailbaseio/trailbase-benchmark) are
kept separately due to their external dependencies.

## Project Structure
Packages and pre-built binaries are available via:

This repository contains all components that make up TrailBase, as well as
tests, documentation and examples.
Only our [benchmarks](https://github.com/trailbaseio/trailbase-benchmark) are
kept separately due to their external dependencies.
- [Docker](https://hub.docker.com/r/trailbase/trailbase)
- [JavaScript/Typescript client](https://www.npmjs.com/package/trailbase)
- [Dart/Flutter client](https://pub.dev/packages/trailbase)

Pre-built static binaries are also available as
[GitHub releases](https://github.com/trailbaseio/trailbase/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 build dependencies (rust, nodejs, pnpm, ...)
installed, you can simply build TrailBase by running:
If you have all the necessary dependencies (rust, nodejs, pnpm, ...) installed,
you can build TrailBase simply by running:

```bash
$ git submodule update --init --recursive
$ cargo build
$ cargo build --release
```

To build fully static binaries on Linux (et al):

```bash
$ RUSTFLAGS="-C target-feature=+crt-static" cargo build --target x86_64-unknown-linux-gnu --release
```

Alternatively, you can build with docker:
Alternatively, if you want a container or don't have to deal with dependencies,
you can build using docker:

```bash
$ git submodule update --init --recursive
Expand All @@ -36,5 +56,5 @@ $ docker build . -t trailbase

## Contributing

Contributions are very welcome, let's just talk upfront to see how a proposal
fits into the overall roadmap and avoid any surprises.
Contributions are very welcome 🙏. Let's talk to see how a proposal fits into
the overall roadmap and avoid surprises.

0 comments on commit 953879c

Please sign in to comment.