AkurAI-Framework / site/content/docs/getting-started.md

Latest change b34c72a614f00efd0c0d58bdc5e3ccc63f07c682 - docs: fix stale info (v0.1.0 status, roadmap, crate table) + file remaining-feature batch ledger (BATCHES.md) by Ólafur Búi Ólafsson

# Getting started

AkurAI/Framework is a single-binary, pure-Rust web framework. There is nothing to
install beyond the binary itself — no language runtime, no package manager, no
build step.

## Create a project

```
akurai new myapp
cd myapp
akurai serve
```

`akurai serve` starts the server on `http://localhost:8090`. Open it and you'll
see the starter page, rendered server-side and pinging the health endpoint from
the client.

## Project layout

A new project is three folders and a config file:

```
myapp/
  frontend/        native-ESM pages, templates, and static assets
  backend/         page.json (context), routes.json (routes), data/*.json (loaders)
  data/            the database file and uploads (created at runtime)
  akurai.toml      scaffolded config; collections.toml is a placeholder for the
                   planned data model (no TOML parser yet — these aren't read)
```

## The core idea

The browser does the rendering; the server stays lean. Pages are server-rendered
from templates against a JSON context, static assets are served as-is, and the
data API is generated from your schema. There is **no JavaScript build step** —
the browser loads native ES modules directly.

> Data lives in the runtime store and in `backend/page.json`. You change content
> by editing files or writing to the database — never by recompiling the binary.

## Next steps

- [Architecture](/docs/architecture) — how the pieces fit together.
- [CLI](/docs/cli) — every command.
- [API reference](/docs/api-reference) — the built-in endpoints.