image
Akan.js
English
DocsConventionsReferencesCheatsheet
image
Akan.js
Akan.js v2 docs are now available.View the v1 docs
DocsConventionsReferencesCheatsheet
Released under the MIT License
Official Akan.js Consulting onAkansoft
Copyright © 2026 Akan.js All rights reserved.
System managed bybassman
Workspace Convention
• Structure
• Format & Lint
App & Library Convention
• Assets (public/ private/)
• Components (ui/)
• Server Utils (srvkit/)
• Web Utils (webkit/)
• Common Utils (common/)
• akan.config.ts
Domain Convention
• Overview
• model.constant.ts
• model.dictionary.ts
• model.document.ts
• model.service.ts
• model.signal.ts
• model.store.ts
• Model.Template.tsx
• Model.Unit.tsx
• Model.Util.tsx
• Model.View.tsx
• Model.Zone.tsx
Scalar Convention
• Overview
• scalar.constant.ts
• scalar.dictionary.ts
• scalar.document.ts
• Scalar.Template.tsx
• Scalar.Unit.tsx
Service Convention
• Overview
• service.dictionary.ts
• service.service.ts
• service.signal.ts
• service.store.ts
• Service.Util.tsx
• Service.Zone.tsx
Workspace Convention
• Structure
• Format & Lint
App & Library Convention
• Assets (public/ private/)
• Components (ui/)
• Server Utils (srvkit/)
• Web Utils (webkit/)
• Common Utils (common/)
• akan.config.ts
Domain Convention
• Overview
• model.constant.ts
• model.dictionary.ts
• model.document.ts
• model.service.ts
• model.signal.ts
• model.store.ts
• Model.Template.tsx
• Model.Unit.tsx
• Model.Util.tsx
• Model.View.tsx
• Model.Zone.tsx
Scalar Convention
• Overview
• scalar.constant.ts
• scalar.dictionary.ts
• scalar.document.ts
• Scalar.Template.tsx
• Scalar.Unit.tsx
Service Convention
• Overview
• service.dictionary.ts
• service.service.ts
• service.signal.ts
• service.store.ts
• Service.Util.tsx
• Service.Zone.tsx
Previous
Scalar.Unit.tsx
Next
service.dictionary.ts

Service Module Overview

A service module is a feature, workflow, or integration folder. It is useful when the code does not start from a document model, but still needs server logic, typed APIs, client state, and sometimes UI.
Service module folders usually start with an underscore. The files inside drop that underscore: `_search` owns `search.service.ts`, `search.signal.ts`, `search.store.ts`, and `Search.Zone.tsx`.

When To Use It

Use a normal module when the feature is centered on a business object such as User, Story, or Order. Use a service module when the feature is centered on an action or platform capability such as search, security, local files, or shared utilities.
_security (libs/util/lib/_security)
Server-only security workflow for encryption, JWT signing, and token verification.
_search (libs/util/lib/_search)
Search feature module with service methods, endpoints, client store, and admin Zone UI.
_localFile (libs/util/lib/_localFile)
Shared file-access service that reads blob data through a typed endpoint.

Service File Map

A service module only needs the files that the feature actually uses. Unlike model-backed modules, it does not own constant, document, template, unit, or view files by default.
search.service.ts
Implements the workflow itself and injects runtime values or other services.
search.signal.ts
Exposes the workflow through endpoint, internal task, cron, or custom route signals.
search.dictionary.ts
Names endpoint labels, endpoint arguments, and service UI phrases.
search.store.ts
Owns service feature state, fetch calls, loading flags, and UI-facing actions.
Search.Util.tsx
Packages small client controls for the service feature when they are reusable.
Search.Zone.tsx
Composes a full service feature section for admin pages or app pages.

Folder Shape

Start small. A server-only module might only have service and signal files. Add dictionary, store, Util, or Zone files when the feature becomes visible to users or admins.
_search service module
Service Module Overview
When To Use It
Service File Map
Folder Shape