diff --git a/README.md b/README.md index 01ff3a9e..e95c680b 100644 --- a/README.md +++ b/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 diff --git a/docs/README.md b/docs/README.md index e09bf55f..f8c04455 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,55 +1,3 @@ -# Starlight Starter Kit: Basics +# TrailBase Website & Documentation -[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build) - -``` -npm create astro@latest -- --template starlight -``` - -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics) -[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics) -[![Deploy with Vercel](https://vercel.com/button)](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. diff --git a/docs/src/assets/screenshot.webp b/docs/src/assets/screenshot.webp index be939926..9052068f 100644 Binary files a/docs/src/assets/screenshot.webp and b/docs/src/assets/screenshot.webp differ diff --git a/docs/src/content/docs/getting-started/first-app.mdx b/docs/src/content/docs/getting-started/first-app.mdx index f08670ac..031b12a7 100644 --- a/docs/src/content/docs/getting-started/first-app.mdx +++ b/docs/src/content/docs/getting-started/first-app.mdx @@ -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. -