image
Akan.js
한국어
문서컨벤션레퍼런스Cheatsheet
image
Akan.js
Akan.js v2 문서가 새로 나왔습니다.v1 문서 보기
문서컨벤션레퍼런스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
다음
구조

Service dictionary

Service dictionary는 endpoint label, endpoint argument, button text, toast message, 작은 UI phrase 같은 service-facing language를 정의합니다. model field에 묶이지 않습니다.
Service module에는 `serviceDictionary(["en", "ko"])`를 사용합니다. service가 API를 노출하면 endpoint translation을 추가하고, UI나 store message에 재사용할 문구가 필요하면 translate key를 추가합니다.

Endpoint label

Endpoint name과 description을 typed 상태로 유지하려면 `.endpoint<Endpoint>()`를 사용합니다. callback key는 signal endpoint method와 일치해야 합니다.
endpoint label

Endpoint argument

endpoint param, search value, body value가 docs, generated UI, admin screen, validation message에서 label이 필요하면 `.arg(...)`를 사용합니다.
one argument

Translate key

Endpoint name이 아닌 service UI phrase에는 `.translate({ ... })`를 사용합니다. toast message, status label, common control, admin UI text에 자주 사용합니다.
service phrases

Key 사용

Client UI는 `l("search.signal.resyncSearchDocuments")`로 service endpoint label을 읽을 수 있습니다. Store action은 service action을 실행할 때 loading, success, error용 translated key를 message로 사용할 수 있습니다.
client usage
Service dictionary
Endpoint label
Endpoint argument
Translate key
Key 사용