akanjs 0.0.1 → 2.0.0-beta.1

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,54 @@
+# Code of Conduct
+
+## Our Pledge
+
+We want Akan.js to be a welcoming, useful, and respectful project for everyone who participates. We pledge to
+make participation in this community harassment-free regardless of age, body size, disability, ethnicity, sex
+characteristics, gender identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment:
+
+- Using welcoming and inclusive language.
+- Respecting different viewpoints and experiences.
+- Giving and receiving constructive feedback gracefully.
+- Focusing disagreement on ideas, trade-offs, and code rather than people.
+- Showing empathy toward other community members.
+
+Examples of unacceptable behavior:
+
+- Harassment, intimidation, or discriminatory language.
+- Personal attacks, trolling, insults, or sustained disruption.
+- Publishing another person's private information without explicit permission.
+- Sexualized language or imagery in community spaces.
+- Any conduct that would reasonably be considered inappropriate in a professional setting.
+
+## Scope
+
+This Code of Conduct applies within project spaces, including issues, pull requests, discussions, documentation,
+community chat, events, and any public context where someone represents the Akan.js project.
+
+## Enforcement
+
+Project maintainers are responsible for clarifying and enforcing acceptable behavior. Maintainers may remove,
+edit, or reject comments, commits, code, issues, pull requests, or other contributions that do not follow this
+Code of Conduct.
+
+Maintainers may also temporarily or permanently limit participation for behavior they consider inappropriate,
+threatening, offensive, or harmful.
+
+## Reporting
+
+If you experience or witness unacceptable behavior, please report it to the project maintainers. If a dedicated
+security or community contact is added later, this section should be updated with that email address or private
+reporting channel.
+
+All reports will be reviewed and investigated. Maintainers will respect the privacy and safety of the reporter
+as much as possible.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/),
+version 2.1.

package/CONTRIBUTING.md

@@ -0,0 +1,83 @@
+# Contributing to Akan.js
+
+Thank you for your interest in contributing to Akan.js. This guide is a starting point for opening issues,
+submitting pull requests, and keeping changes reviewable.
+
+## Project Shape
+
+Akan.js is a Bun-first TypeScript monorepo.
+
+- `pkgs/akanjs`: framework package, runtime surfaces, CLI, devkit, and tooling.
+- `apps`: application examples and product surfaces built with Akan.
+- `libs`: shared domain and utility libraries.
+- `infra`: deployment, Helm, edge, and CI/CD assets.
+
+When changing framework code, prefer existing package subpaths and keep the root `akanjs` entrypoint small.
+Runtime boundaries are part of the package design.
+
+## Before You Start
+
+- Search existing issues and pull requests before opening a new one.
+- Keep changes focused on one concern at a time.
+- Prefer existing patterns over new abstractions.
+- Avoid broad formatting-only changes unless the pull request is explicitly about formatting.
+- Do not commit secrets, generated credentials, local `.env` files, or private deployment values.
+
+## Development
+
+Install dependencies with Bun:
+
+```bash
+bun install
+```
+
+Useful commands:
+
+```bash
+bun run akan lint-all --fix=false
+bun run akan build <appName>
+bun run akan start <appName>
+```
+
+After changing application source code, verify the affected app when practical:
+
+```bash
+bun run akan start <appName>
+bun run akan build <appName>
+```
+
+## Pull Request Guidelines
+
+A good pull request should include:
+
+- A short explanation of the problem and the approach.
+- Screenshots or recordings for visible UI changes.
+- Tests, examples, or manual verification notes for behavior changes.
+- Notes about breaking changes, migration steps, or follow-up work.
+
+Reviewers should be able to understand the change from the pull request description and the diff without
+reverse-engineering unrelated context.
+
+## Coding Style
+
+- Use TypeScript and Bun-first workflows.
+- Follow the existing file layout, naming conventions, and module boundaries.
+- Use Biome formatting conventions used by the repository.
+- Keep code readable six months from now: clear declarations beat clever shortcuts.
+- Add comments only when they explain non-obvious behavior or decisions.
+
+## Reporting Issues
+
+When reporting a bug, include:
+
+- The Akan.js version or commit.
+- The Bun version and operating system.
+- A minimal reproduction or the smallest code sample that shows the problem.
+- Expected behavior and actual behavior.
+- Relevant logs, stack traces, or screenshots.
+
+For feature requests, describe the business problem first, then the API or behavior you would like to see.
+
+## License
+
+By contributing to this repository, you agree that your contributions will be licensed under the MIT License.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Akan Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.ko.md

@@ -0,0 +1,244 @@
+# Akan.js
+
+[English](./README.md) | [Docs](https://akanjs.com/docs) | [npm](https://www.npmjs.com/package/akanjs)
+
+**코드가 아니라, 비즈니스를 씁니다.**  
+**Write the business, not the plumbing.**
+
+Akan.js는 비즈니스 정의가 곧 애플리케이션이 되도록 설계된 Bun-first 풀스택 TypeScript
+프레임워크입니다. 하나의 코드베이스에서 SEO 웹, iOS/Android 앱 화면, 서버, 데이터베이스 계약,
+인프라 산출물, 문서화까지 이어갑니다.
+
+```bash
+bunx create-akan-workspace@latest
+```
+
+## 왜 Akan인가
+
+Akan은 기술 계층마다 같은 의도를 다시 쓰는 대신, 비즈니스가 무엇을 하는지 또렷하게 선언하도록
+돕습니다. 도메인을 한 번 정의하면 schema, API, fetch client, store, UI, server, deployment
+artifact, generated reference가 같은 의도에서 이어집니다.
+
+- **Agents write**: 비즈니스 정의가 코드의 원천입니다. 반복적인 프레임워크 코드는 생성과 규칙이 맡습니다.
+- **Keep it minimal**: 한 줄의 의도가 웹, 앱, 서버, 데이터베이스, 배포까지 이어집니다.
+- **Always readable**: 적은 파일, 엄격한 규칙, 예측 가능한 선언 방식으로 6개월 뒤에도 읽히는 코드를 만듭니다.
+- **Nice to review**: 군더더기 없는 도메인 변경은 확인하기 쉽고, 리뷰가 빠르며, 곧장 배포하기 좋습니다.
+
+## 요구사항
+
+- [Bun](https://bun.sh) `>=1.3.13`
+- TypeScript 중심의 애플리케이션 코드
+- React 기반 UI surface
+
+## 빠른 시작
+
+바로 워크스페이스를 만들 수 있습니다.
+
+```bash
+bunx create-akan-workspace@latest
+```
+
+CLI를 전역으로 설치해서 사용할 수도 있습니다.
+
+```bash
+bun install -g akanjs --latest
+akan create-workspace
+cd <workspace-name>
+akan start <app-name> --open
+```
+
+가장 작은 앱은 설정이 거의 없어도 시작할 수 있습니다.
+
+```ts
+import type { AppConfig } from "akanjs/devkit";
+
+const config: AppConfig = {};
+
+export default config;
+```
+
+프로덕션 앱은 `akan.config.ts`에서 routes, base paths, domains, mobile metadata, deployment options로
+자연스럽게 확장됩니다.
+
+## 오래 읽히는 코드
+
+Akan은 오래 운영되는 애플리케이션을 이해하기 쉽게 유지하기 위해 중요한 결정을 명시적이고 반복
+가능한 형태로 둡니다.
+
+- **하나의 설정 표면**: `akan.config.ts`가 앱 단위 설정의 중심입니다. routes, domains, base paths,
+  mobile settings, deployment options가 필요해질 때까지 비워둘 수 있습니다.
+- **모노리포 기반 재사용**: shared library와 domain module이 기본 단위이므로 검증된 비즈니스 코드를
+  앱마다 다시 만들지 않고 함께 사용할 수 있습니다.
+- **엄격한 구조, 익숙한 코드**: 파일 위치, 파일명, 선언 방식, module boundary가 워크스페이스 전반에서
+  같은 패턴을 따르므로 다른 사람이 짠 코드도 내가 짠 코드처럼 읽힙니다.
+
+## 도메인 모듈
+
+Akan 개발의 중심 단위는 도메인 모듈입니다. 기술 계층별로 먼저 나누기보다 `user`, `product`,
+`ticket`, `project`처럼 비즈니스 도메인별로 코드를 묶습니다.
+
+```text
+lib/product/
+├── product.constant.ts    # 모델, 스칼라, enum, 스키마 정의
+├── product.dictionary.ts  # i18n 라벨, 설명, 에러
+├── product.signal.ts      # 타입 안전한 endpoint 계약
+├── product.document.ts    # 영속성과 document query
+├── product.service.ts     # 비즈니스 로직
+├── product.store.ts       # 도메인 상태와 action
+├── Product.Template.tsx   # form 중심 UI
+├── Product.Unit.tsx       # list/item UI
+├── Product.View.tsx       # detail UI
+└── Product.Zone.tsx       # page/container UI
+```
+
+```mermaid
+flowchart LR
+  ConstantDictionarySignal["constant + dictionary + signal"] --> DocumentService["document + service"]
+  ConstantDictionarySignal --> StoreComponents["store + UI components"]
+  DocumentService --> ServerRuntime["server runtime"]
+  StoreComponents --> ClientRuntime["client runtime"]
+  ServerRuntime --> DeployArtifacts["deploy artifacts"]
+  ClientRuntime --> DeployArtifacts
+```
+
+하나의 모델과 하나의 계약이 DB, 서버, API, 상태관리, UI까지 이어지기 때문에 계층마다 의도를
+반복해서 작성할 필요가 줄어듭니다.
+
+## Akan이 만드는 것
+
+Akan은 보통 여러 프로젝트로 흩어지는 것들을 하나의 프레임워크로 묶습니다.
+
+- SEO에 최적화된 server-side rendered web surface.
+- 아름다운 페이지 전환을 가진 iOS/Android 친화 client-side rendered app surface.
+- Bun 기반 HTTP/WebSocket server.
+- SQLite-first 단순 서버 경로와 더 큰 시스템을 위한 Postgres/Redis 확장 경로.
+- Schema validation, error handling, security helper, middleware.
+- DB schema에서 server, API, state, UI까지 이어지는 type-safe flow.
+- Schema, error, API description, UI copy에 걸친 i18n.
+- 같은 정의에서 생성되는 DB/API 문서와 테스트 가능한 endpoint reference.
+- Upload, authentication, admin, chat, board, notification 같은 조립 가능한 feature block.
+
+배포와 문서 작성에 하루를 쓰고 있다면 뭔가 잘못된 것입니다. Akan은 schema와 endpoint 정의가
+table reference, runtime contract, API docs, testable endpoint reference가 되도록 설계됩니다.
+
+## 하나의 패키지, 여러 경계
+
+Akan은 하나의 npm package인 `akanjs`로 배포됩니다.
+
+root import는 의도적으로 작게 유지됩니다. server-only, client-only, UI, tooling surface를 명확히
+나누기 위해 subpath import를 사용하세요.
+
+```ts
+import { Int, dayjs } from "akanjs/base";
+import { via } from "akanjs/constant";
+import { endpoint } from "akanjs/signal";
+import { fetch } from "akanjs/fetch";
+import { Button, Layout } from "akanjs/ui";
+import type { PageConfig } from "akanjs/client";
+```
+
+```css
+@import "akanjs/ui/styles.css";
+```
+
+이 구조는 설치와 업데이트를 단순하게 만들면서도 런타임 경계를 유지합니다. 프론트엔드 빌드는
+UI barrel import를 leaf import로 다시 써서 클라이언트 번들을 작게 유지할 수 있습니다.
+
+## 패키지 Surface
+
+| Subpath | 역할 |
+| --- | --- |
+| `akanjs/base` | core primitive, scalar helper, environment helper, symbol, common type. |
+| `akanjs/common` | 여러 Akan surface에서 함께 쓰는 cross-runtime helper. |
+| `akanjs/constant` | model declaration, schema shaping, serialization, default, `via` builder. |
+| `akanjs/dictionary` | locale, translation, natural-language metadata helper. |
+| `akanjs/document` | database document schema, query builder, loader, persistence utility. |
+| `akanjs/signal` | endpoint, slice, guard, middleware, serializer, typed signal contract. |
+| `akanjs/service` | service module, adaptor, dependency injection metadata, business logic runtime. |
+| `akanjs/fetch` | typed fetch client, HTTP client, WebSocket client, request storage. |
+| `akanjs/store` | domain state, action, store registry, root-store helper. |
+| `akanjs/ui` | layout, form, modal, table, loading, model view 등 React UI component. |
+| `akanjs/client` | client routing, cookie, storage, locale, device, CSR type, page helper. |
+| `akanjs/client` | Akan page runtime에서 사용하는 client bootstrap과 location helper. |
+| `akanjs/server` | server app runtime, route composition, SSR/RSC artifact, proxy, sitemap, server type. |
+| `akanjs/devkit` | build runner, config loader, code generation, scanner, transform, CLI helper, tooling. |
+| `akanjs/test` | test helper와 sample generation utility. |
+| `akanjs/cli` | programmatic CLI entrypoint. 실행 명령은 `akan`입니다. |
+
+특수 public surface:
+
+- `akanjs/ui/styles.css`
+- `akanjs/capacitor.base.config`
+- `akanjs/server/rsc-worker`
+- `akanjs/package.json`
+
+## CLI 개요
+
+`akan` 명령은 워크스페이스 전체 생명주기를 관리합니다.
+
+```bash
+akan create-workspace
+akan create-application <app-name>
+akan create-module
+akan create-scalar
+akan start <app-name> --open
+akan build <app-name>
+akan lint-all
+akan update
+```
+
+주요 영역:
+
+- **Workspace**: workspace 생성, Mongo 설정 생성, lint, sync.
+- **Application**: app start, build, typecheck, package, release.
+- **Library**: shared library 생성, 설치, sync, push, pull.
+- **Module and scalar**: domain module, model, view, unit, template, store 생성.
+- **Cloud and release**: deployment asset 준비와 Akan package version update.
+- **Guidelines**: agent와 contributor를 위한 framework coding guideline 생성과 확인.
+
+## 애플리케이션 설정
+
+`akan.config.ts`는 앱 단위 설정의 중심입니다. 단순한 앱에서는 비어 있을 수 있고, 필요할 때만
+routes, domains, base paths, mobile settings로 확장됩니다.
+
+```ts
+import type { AppConfig } from "akanjs/devkit";
+
+const config: AppConfig = {
+  routes: [
+    { domains: { main: ["example.com", "www.example.com"] }, basePath: "web" },
+    { domains: {}, basePath: "app" },
+  ],
+  mobile: {
+    appName: "Example",
+    appId: "com.example.app",
+    version: "1.0.0",
+    buildNum: 1,
+  },
+};
+
+export default config;
+```
+
+## Contributor Notes
+
+이 저장소는 Bun-first monorepo입니다. Framework code는 `pkgs/akanjs`, application은 `apps`,
+shared library는 `libs`, deployment asset은 `infra`에 있습니다.
+
+유용한 명령:
+
+```bash
+akan lint-all --fix=false
+akan build <appName>
+akan start <appName>
+```
+
+framework code를 수정할 때는 기존 subpath를 우선 사용하고 root `akanjs` entrypoint는 작게 유지하세요.
+이 package boundary는 runtime design의 일부입니다.
+
+## 오픈소스 메모
+
+- License: MIT. root `LICENSE`를 참고하세요.
+- Repository: [akan-team/akanjs](https://github.com/akan-team/akanjs).
+- Contribution guide: root `CONTRIBUTING.md`를 참고하세요.
+- Code of conduct: root `CODE_OF_CONDUCT.md`를 참고하세요.

package/README.md

@@ -1,11 +1,242 @@
-# akan
+# Akan.js
 
-This library was generated with [Nx](https://nx.dev).
+[한국어](./README.ko.md) | [Docs](https://akanjs.com/docs) | [npm](https://www.npmjs.com/package/akanjs)
 
-## Building
+**Write the business, not the plumbing.**
 
-Run `nx build akan` to build the library.
+Akan.js is a Bun-first full-stack TypeScript framework for teams that want business definitions to be the
+application. One cohesive codebase can produce SEO web surfaces, iOS and Android app surfaces, servers,
+database contracts, infrastructure artifacts, and documentation.
 
-## Running unit tests
+```bash
+bunx create-akan-workspace@latest
+```
 
-Run `nx test akan` to execute the unit tests via [Jest](https://jestjs.io).
+## Why Akan
+
+Akan is designed for teams and solo builders who would rather describe what the business does than keep
+rewriting the same intent for each technical layer. Define the domain once, then let the framework connect
+the schema, API, fetch client, store, UI, server, deployment artifacts, and generated references.
+
+- **Agents write**: business definitions are the source of truth; generation handles repetitive framework code.
+- **Keep it minimal**: one line of intent can flow across web, app, server, database, and deployment.
+- **Always readable**: fewer files, strict conventions, and predictable declarations keep code clear months later.
+- **Nice to review**: focused domain changes are easier to inspect, approve, and ship.
+
+## Requirements
+
+- [Bun](https://bun.sh) `>=1.3.13`
+- TypeScript-first application code
+- React-based UI surfaces
+
+## Quick Start
+
+Create a workspace directly:
+
+```bash
+bunx create-akan-workspace@latest
+```
+
+Or install the CLI globally:
+
+```bash
+bun install -g akanjs --latest
+akan create-workspace
+cd <workspace-name>
+akan start <app-name> --open
+```
+
+A minimal app can start with almost no configuration:
+
+```ts
+import type { AppConfig } from "akanjs/devkit";
+
+const config: AppConfig = {};
+
+export default config;
+```
+
+Production apps can grow into routes, base paths, domains, mobile metadata, and deployment options through
+`akan.config.ts`.
+
+## Readable By Design
+
+Akan keeps long-lived applications understandable by making the important decisions explicit and repeatable.
+
+- **One configuration surface**: `akan.config.ts` is the app-level control plane. It can stay empty until the
+  app actually needs routes, domains, base paths, mobile settings, or deployment options.
+- **Monorepo-native reuse**: shared libraries and domain modules are first-class, so validated business code can
+  be reused without rebuilding the same wheel in each app.
+- **Strict structure, familiar code**: file locations, names, declarations, and module boundaries follow the same
+  pattern across the workspace, so code written by another contributor still reads like local code.
+
+## The Domain Module
+
+The domain module is the center of Akan development. Instead of organizing code by technical layer first,
+Akan organizes code around business domains such as `user`, `product`, `ticket`, or `project`.
+
+```text
+lib/product/
+├── product.constant.ts    # model, scalar, enum, schema definition
+├── product.dictionary.ts  # i18n labels, descriptions, errors
+├── product.signal.ts      # typed endpoint contract
+├── product.document.ts    # persistence and document queries
+├── product.service.ts     # business logic
+├── product.store.ts       # domain state and actions
+├── Product.Template.tsx   # form-oriented UI
+├── Product.Unit.tsx       # list/item UI
+├── Product.View.tsx       # detail UI
+└── Product.Zone.tsx       # page/container UI
+```
+
+```mermaid
+flowchart LR
+  ConstantDictionarySignal["constant + dictionary + signal"] --> DocumentService["document + service"]
+  ConstantDictionarySignal --> StoreComponents["store + UI components"]
+  DocumentService --> ServerRuntime["server runtime"]
+  StoreComponents --> ClientRuntime["client runtime"]
+  ServerRuntime --> DeployArtifacts["deploy artifacts"]
+  ClientRuntime --> DeployArtifacts
+```
+
+This structure lets one model and one contract flow through the database, server, API, state management,
+and UI without duplicating intent across layers.
+
+## What Akan Builds
+
+Akan is one framework for the pieces that normally become separate projects:
+
+- SEO-optimized server-side rendered web surfaces.
+- iOS and Android friendly client-side rendered app surfaces with page transitions.
+- Bun-powered HTTP and WebSocket servers.
+- SQLite-first simple server paths, with Postgres and Redis expansion paths for larger systems.
+- Schema validation, error handling, security helpers, and middleware.
+- Type-safe flow from database schema to server, API, state, and UI.
+- Internationalized schemas, errors, API descriptions, and UI copy.
+- Generated database and API documentation from the same definitions that run the app.
+- Composable feature blocks for upload, authentication, admin, chat, boards, and notifications.
+
+Deployment and documentation should not consume a day of work. Akan is built so schema and endpoint
+definitions can also become table references, runtime contracts, API docs, and testable endpoint references.
+
+## One Package, Many Boundaries
+
+Akan is published as a single npm package: `akanjs`.
+
+The root import is intentionally small. Use subpath imports to keep server-only, client-only, UI, and
+tooling surfaces clear:
+
+```ts
+import { Int, dayjs } from "akanjs/base";
+import { via } from "akanjs/constant";
+import { endpoint } from "akanjs/signal";
+import { fetch } from "akanjs/fetch";
+import { Button, Layout } from "akanjs/ui";
+import type { PageConfig } from "akanjs/client";
+```
+
+```css
+@import "akanjs/ui/styles.css";
+```
+
+This model keeps install and update flows simple while preserving runtime boundaries and allowing the
+frontend build to rewrite UI barrel imports into leaf imports.
+
+## Package Surface
+
+| Subpath | Purpose |
+| --- | --- |
+| `akanjs/base` | Core primitives, scalar helpers, environment helpers, symbols, and common types. |
+| `akanjs/common` | Shared cross-runtime helpers used by multiple Akan surfaces. |
+| `akanjs/constant` | Model declarations, schema shaping, serialization, defaults, and the `via` builder. |
+| `akanjs/dictionary` | Locale, translation, and dictionary helpers for natural-language metadata. |
+| `akanjs/document` | Database document schemas, query builders, loaders, and persistence utilities. |
+| `akanjs/signal` | Endpoint, slice, guard, middleware, serializer, and typed signal contracts. |
+| `akanjs/service` | Service modules, adaptors, dependency injection metadata, and business logic runtime. |
+| `akanjs/fetch` | Typed fetch clients, HTTP clients, WebSocket clients, and request storage. |
+| `akanjs/store` | Domain state, actions, store registry, and root-store helpers. |
+| `akanjs/ui` | React components and UI primitives such as layout, form, modal, table, loading, and model views. |
+| `akanjs/client` | Client routing, cookies, storage, locale, device, CSR types, and page helpers. |
+| `akanjs/client` | Client bootstrapping and location helpers used by Akan page runtimes. |
+| `akanjs/server` | Server app runtime, route composition, SSR/RSC artifacts, proxying, sitemap, and server types. |
+| `akanjs/devkit` | Build runners, config loaders, code generation, scanners, transforms, CLI helpers, and tooling. |
+| `akanjs/test` | Test helpers and sample generation utilities. |
+| `akanjs/cli` | Programmatic CLI entrypoint. The executable command is `akan`. |
+
+Special public surfaces:
+
+- `akanjs/ui/styles.css`
+- `akanjs/capacitor.base.config`
+- `akanjs/server/rsc-worker`
+- `akanjs/package.json`
+
+## CLI Overview
+
+The `akan` command manages the whole workspace lifecycle.
+
+```bash
+akan create-workspace
+akan create-application <app-name>
+akan create-module
+akan create-scalar
+akan start <app-name> --open
+akan build <app-name>
+akan lint-all
+akan update
+```
+
+Common areas:
+
+- **Workspace**: create workspaces, generate Mongo configuration, lint and sync projects.
+- **Application**: start, build, typecheck, package, and release apps.
+- **Library**: create, install, sync, push, and pull shared libraries.
+- **Module and scalar**: generate domain modules, models, views, units, templates, and stores.
+- **Cloud and release**: prepare deployment assets and update Akan package versions.
+- **Guidelines**: generate and inspect framework coding guidelines for agents and contributors.
+
+## Application Configuration
+
+`akan.config.ts` is the single place for app-level configuration. It can be empty for simple apps, then
+grow only when the app needs routes, domains, base paths, or mobile settings.
+
+```ts
+import type { AppConfig } from "akanjs/devkit";
+
+const config: AppConfig = {
+  routes: [
+    { domains: { main: ["example.com", "www.example.com"] }, basePath: "web" },
+    { domains: {}, basePath: "app" },
+  ],
+  mobile: {
+    appName: "Example",
+    appId: "com.example.app",
+    version: "1.0.0",
+    buildNum: 1,
+  },
+};
+
+export default config;
+```
+
+## Contributor Notes
+
+This repository is a Bun-first monorepo. Framework code lives under `pkgs/akanjs`, applications under
+`apps`, shared libraries under `libs`, and deployment assets under `infra`.
+
+Useful commands:
+
+```bash
+akan lint-all --fix=false
+akan build <appName>
+akan start <appName>
+```
+
+When editing framework code, prefer established subpaths and keep the root `akanjs` entrypoint small.
+The package boundary is part of the runtime design.
+
+## Open Source Notes
+
+- License: MIT. See the root `LICENSE`.
+- Repository: [akan-team/akanjs](https://github.com/akan-team/akanjs).
+- Contribution guide: see the root `CONTRIBUTING.md`.
+- Code of conduct: see the root `CODE_OF_CONDUCT.md`.