mirror of
https://github.com/trailbaseio/trailbase.git
synced 2025-12-21 09:29:44 -06:00
Update documentation post 0.1.1 and screenshots to show logs with geoip map.
This commit is contained in:
28
README.md
28
README.md
@@ -9,6 +9,7 @@ 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.
|
||||
If you like TrailBase or its prospect, consider leaving a ⭐🙏.
|
||||
|
||||
## Project Structure & Releases
|
||||
|
||||
@@ -17,14 +18,35 @@ libraries, tests, documentation and examples.
|
||||
Only the [benchmarks](https://github.com/trailbaseio/trailbase-benchmark) are
|
||||
kept separately due to their external dependencies.
|
||||
|
||||
Packages and pre-built binaries are available via:
|
||||
Pre-built static binaries are available as [GitHub
|
||||
releases](https://github.com/trailbaseio/trailbase/releases/) for Linux an
|
||||
MacOS.
|
||||
|
||||
Moreover, client packages and containers are available via:
|
||||
|
||||
- [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/).
|
||||
## Running
|
||||
|
||||
You can run pre-built TrailBase either by downloading the latest
|
||||
[release](https://github.com/trailbaseio/trailbase/releases/) and running
|
||||
|
||||
```bash
|
||||
$ ./trail run
|
||||
```
|
||||
|
||||
or using docker:
|
||||
|
||||
```bash
|
||||
$ mkdir traildepot
|
||||
$ alias trail="docker run -p 4000:4000 --mount type=bind,source=$PWD/traildepot,target=/app/traildepot trailbase/trailbase /app/trail"
|
||||
$ trail run
|
||||
```
|
||||
|
||||
. Run `trail --help` to get a full list of commands. If you don't want to rely
|
||||
on pre-built binaries, TrailBase is easy to build yourself, see below.
|
||||
|
||||
## Building
|
||||
|
||||
|
||||
@@ -1,55 +1,3 @@
|
||||
# Starlight Starter Kit: Basics
|
||||
# TrailBase Website & Documentation
|
||||
|
||||
[](https://starlight.astro.build)
|
||||
|
||||
```
|
||||
npm create astro@latest -- --template starlight
|
||||
```
|
||||
|
||||
[](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
|
||||
[](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
|
||||
[](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
|
||||
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
|
||||
|
||||
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
|
||||
|
||||
## 🚀 Project Structure
|
||||
|
||||
Inside of your Astro + Starlight project, you'll see the following folders and files:
|
||||
|
||||
```
|
||||
.
|
||||
├── public/
|
||||
├── src/
|
||||
│ ├── assets/
|
||||
│ ├── content/
|
||||
│ │ ├── docs/
|
||||
│ │ └── config.ts
|
||||
│ └── env.d.ts
|
||||
├── astro.config.mjs
|
||||
├── package.json
|
||||
└── tsconfig.json
|
||||
```
|
||||
|
||||
Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
|
||||
|
||||
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
|
||||
|
||||
Static assets, like favicons, can be placed in the `public/` directory.
|
||||
|
||||
## 🧞 Commands
|
||||
|
||||
All commands are run from the root of the project, from a terminal:
|
||||
|
||||
| Command | Action |
|
||||
| :------------------------ | :----------------------------------------------- |
|
||||
| `npm install` | Installs dependencies |
|
||||
| `npm run dev` | Starts local dev server at `localhost:4321` |
|
||||
| `npm run build` | Build your production site to `./dist/` |
|
||||
| `npm run preview` | Preview your build locally, before deploying |
|
||||
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
|
||||
| `npm run astro -- --help` | Get help using the Astro CLI |
|
||||
|
||||
## 👀 Want to learn more?
|
||||
|
||||
Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
|
||||
This directory contains the https://trailbase.io site.
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 106 KiB After Width: | Height: | Size: 89 KiB |
@@ -19,8 +19,11 @@ simply trying out TrailBase with an existing SQLite-based data analysis
|
||||
project, we will also offer a alternative path to bootstrapping the database
|
||||
using the vanilla `sqlite3` CLI.
|
||||
|
||||
<Aside type="note" title="Note">
|
||||
Just like in the previous section, you can use docker to run arbitrary TrailBase commands like:
|
||||
<Aside type="note" title="Running TrailBase">
|
||||
You can either downloaded the latest pre-built
|
||||
[release](https://github.com/trailbaseio/trailbase/releases/)
|
||||
or use docker, like in the previous section, to run arbitrary TrailBase
|
||||
commands:
|
||||
|
||||
```bash
|
||||
mkdir traildepot
|
||||
|
||||
Reference in New Issue
Block a user