Akan.js
English
English
한국어
Docs
Conventions
References
Cheatsheet
Akan.js
Akan.js v2 docs are now available.
View the v1 docs
Docs
Conventions
References
Cheatsheet
MIT 라이선스 하에 배포되었습니다.
Akan.js 공식 컨설팅 서비스
Akansoft
Copyright © 2026 Akan.js 모든 권리 보유.
시스템 관리자
bassman
워크스페이스 규칙
•
구조
•
포맷 & 린트
앱 & 라이브러리 규칙
•
애셋 (public/ private/)
•
컴포넌트 (ui/)
•
서버 유틸리티 (srvkit/)
•
웹 유틸리티 (webkit/)
•
공통 유틸리티 (common/)
•
akan.config.ts
도메인 규칙
•
개요
•
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.constant.ts
•
scalar.dictionary.ts
•
scalar.document.ts
•
Scalar.Template.tsx
•
Scalar.Unit.tsx
서비스 규칙
•
개요
•
service.dictionary.ts
•
service.service.ts
•
service.signal.ts
•
service.store.ts
•
Service.Util.tsx
•
Service.Zone.tsx
워크스페이스 규칙
•
구조
•
포맷 & 린트
앱 & 라이브러리 규칙
•
애셋 (public/ private/)
•
컴포넌트 (ui/)
•
서버 유틸리티 (srvkit/)
•
웹 유틸리티 (webkit/)
•
공통 유틸리티 (common/)
•
akan.config.ts
도메인 규칙
•
개요
•
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.constant.ts
•
scalar.dictionary.ts
•
scalar.document.ts
•
Scalar.Template.tsx
•
Scalar.Unit.tsx
서비스 규칙
•
개요
•
service.dictionary.ts
•
service.service.ts
•
service.signal.ts
•
service.store.ts
•
Service.Util.tsx
•
Service.Zone.tsx
Next
구조
Module 개요
Akan module은 하나의 business feature folder입니다. model shape, language, persistence behavior, business workflow, API, client state, UI 조각을 가까운 곳에 함께 둡니다.
이 overview는 지도입니다. 다음에 어떤 파일을 열어야 하는지 파악한 뒤, 자세한 패턴과 예시는 각 detail page에서 확인하세요.
Module file map
대부분의 module은 data/server 파일과 UI/client 파일 두 그룹으로 나누면 이해하기 쉽습니다. 각 card는 해당 guide로 이동합니다.
Data와 server 파일
model.constant.ts
field, enum, model layer, helper, hidden/secret field, resolved field 등 business data shape을 정의합니다.
model.dictionary.ts
field, insight, query, slice, endpoint, error, UI text 등 사용자에게 보이는 언어를 정의합니다.
model.document.ts
filter, document method, model-level helper, index, schema hook 등 persistence 동작을 정의합니다.
model.service.ts
business workflow를 담당하고 generated document method, injected service, database operation을 조율합니다.
model.signal.ts
API, slice, realtime message, pubsub channel, internal task, guard, resolved field handler를 노출합니다.
model.store.ts
client state, form state, list state, generated fetch call, toast message, UI-facing action을 조율합니다.
UI와 client 파일
Model.Template.tsx
store form state와 generated setter에 연결된 form 조각과 interaction fragment를 렌더링합니다.
Model.Unit.tsx
card, row, avatar, column, compact summary 같은 light-model display 조각을 렌더링합니다.
Model.View.tsx
detail page, view modal, complete model data가 필요한 section의 full-model detail UI를 렌더링합니다.
Model.Util.tsx
action button, toolbox, dialog, query panel, navigation helper 같은 작은 client helper UI를 묶습니다.
Model.Zone.tsx
Load.Units, Load.View, Unit/View display, Util control, section-level UI state로 page section을 조립합니다.
Server to client 흐름
module은 보통 data shape에서 persistence로, 그다음 API, client state, UI로 확장됩니다. 모든 feature에 모든 파일이 필요한 것은 아니지만, 이 순서를 따르면 역할이 명확해집니다.
constant
business shape과 generated model layer에서 시작합니다.
dictionary
field, action, error, UI phrase에 사용자에게 보이는 이름을 붙입니다.
document
저장된 document를 query, change, index, load하는 방식을 설명합니다.
service
document helper와 다른 service를 사용해 business workflow를 구현합니다.
signal
server behavior를 typed slice, endpoint, realtime channel, task로 노출합니다.
store
generated fetch API를 client state, form state, UI action에 연결합니다.
UI files
form, list, detail view, action, page section을 렌더링합니다.
module flow
역할 경계
module이 헷갈리기 시작하는 경우는 보통 logic이 잘못된 파일에 들어갔기 때문입니다. 코드를 추가하기 전에 아래 경계를 확인하세요.
Business rules
service, document, constant helper에 둡니다. render code 안에 숨기지 않습니다.
API and access
slice, endpoint, guard, internal arg, realtime, task는 signal에 둡니다.
Client coordination
fetch call, form state, list state, toast message, UI action은 store에 둡니다.
Display
반복되는 light-model display는 Unit, full-model detail display는 View를 사용합니다.
Page sections
Load wrapper, Unit/View, Util control, section layout 조립에는 Zone을 사용합니다.
Small controls
toolbox, action button, dialog trigger, query panel, navigation helper에는 Util을 사용합니다.
추천 읽기 순서
지금 만들려는 작업에서 시작하세요. 각 경로의 첫 파일이 변경을 조사하거나 설계하기 가장 좋은 시작점입니다.
새 Model
constant -> dictionary -> document -> service -> signal -> store
business object를 처음 정의할 때 이 순서로 읽습니다.
새 List Page
signal slice -> store -> Zone -> Unit
page에 list data, filtering, pagination, card가 필요할 때 이 순서로 읽습니다.
새 Detail/Edit Page
signal view -> store -> Zone/View -> Template
full data를 보여주거나 기존 model을 edit할 때 이 순서로 읽습니다.
새 Action
service -> signal endpoint -> store action -> Util/Template button
사용자 클릭이 business workflow를 실행해야 할 때 이 순서로 읽습니다.
실전 규칙
overview는 짧게 유지합니다. 자세한 syntax와 example은 각 파일별 guide에 둡니다.
shape를 직접 복사하지 말고 generated type과 helper로 파일들을 연결합니다.
feature가 저장된 data를 변경한다면 UI보다 server behavior를 먼저 설계합니다.
UI 파일은 composition과 presentation에 사용하고, 숨겨진 business decision을 넣지 않습니다.
section이 커지면 Zone을 키우기 전에 display는 Unit/View로, control은 Util로 옮깁니다.
Module 개요
Module file map
Server to client 흐름
역할 경계
추천 읽기 순서
실전 규칙
