Quick Start

Akan.js is a full-stack TypeScript framework that prioritizes designing and implementing actual business code.

You can build a type-safe service with minimal code and deploy it to web, mobile, server, and DB infrastructure at the same time.

This guide takes you from an empty directory to a running app.

Requirements

Bun is the only required dependency for the first run.

Bun 1.4.0 or higher

Git for source code management

Android Studio or Xcode for native app builds

Create a Workspace

The quickest way is to let your coding agent do it. Open Claude Code or Codex in an empty directory and paste this prompt. It checks Bun, creates the workspace and starts the app:

Set up a new Akan.js workspace for me (https://akanjs.com).

1. Check that Bun 1.4 or newer is installed (`bun --version`). If it isn't, install or upgrade it as https://bun.sh describes.
2. Ask me for a workspace name and a first app name, short and lowercase, unless I wrote them below.
3. In this directory, run `bunx create-akan-workspace@latest <workspace> --app <app>`. It installs the akan CLI globally, creates ./<workspace> and installs its dependencies.
4. Inside ./<workspace>, start the dev server in the background with `akan start <app>` and check that the URL it prints (http://localhost:8282 by default) loads.
5. Tell me it's running, and that I should reopen you inside ./<workspace>: the project's Akan MCP server and AGENTS.md rules load from there.

To create it yourself, run the workspace creator. It asks for a workspace name and an app name:

Terminal

Or use the globally installed akan command:

Terminal

Run the App

Start the app with one command:

Terminal

The app opens on http://localhost:8282.

Edit a page

Akan pages live under apps/<app>/page. Edit the first screen and refresh:

apps/myapp/page/_index.tsx

http://localhost:8282

Hello Akan.js! 🎉

Know the app entry

The generated main.ts starts the Akan runtime.

apps/myapp/main.ts

The terminal shows the local runtime status.

Terminal

Build

Build the app for production:

Terminal

The result is generated in the dist/apps/myapp directory.

NextFundamentals