Demo

သွင်းခြင်း

@quan-erp/cli ကို သွင်းပြီး၊ quan-erp new-project ဖြင့် project ကို scaffold လုပ်ကာ၊ base stack ကို စတင်ပြီးနောက်၊ plugin ကို တည်ဆောက်၍ မှတ်ပုံတင်ရပါသည်။

1. လိုအပ်ချက်များ (Prerequisites)

Project မဖန်တီးမီ အောက်ပါတို့ကို စက်တွင် သွင်းထားရပါမည်။ CLI နှင့် plugin တည်ဆောက်မှုအတွက် Node.js လိုအပ်ပြီး၊ base stack အတွက် Docker လိုအပ်ပါသည်။

လိုအပ်ချက်မှတ်ချက်သွင်းရန်
Node.js 18+20+ LTS ကို အကြံပြုပါသည် — @quan-erp/cli နှင့် plugin npm install အတွက် လိုအပ်ပါသည်Install →
Docker Engine + Compose v2Postgres၊ Redis၊ backend နှင့် frontend ကို လည်ပတ်စေပါသည်Install →
ပံ့ပိုးသော OSmacOS၊ Linux၊ သို့မဟုတ် Windows နှင့် Docker Desktop / WSL2—
Disk နှင့် RAMimage နှင့် volume အတွက် နေရာလွတ် လုံလောက်စွာ ထားရှိပါ; ဒေသခံ compose အတွက် ~4 GB RAM ကို အကြံပြုပါသည်—

2. CLI သွင်းခြင်း

တရားဝင် Quark ERP CLI ကို @quan-erp/cli အဖြစ် ထုတ်ဝေထားပါသည်။ Global သွင်းပြီးနောက် အဓိက command မှာ quan-erp ဖြစ်ပြီး၊ quark-erp နှင့် erp တို့မှာ alias များ ဖြစ်ပါသည်။

SHTerminal
npm i -g @quan-erp/cli quan-erp help
@quan-erp/cli on npm →

3. Project ဖန်တီးခြင်း

ဗလာ folder တစ်ခုတွင် quan-erp new-project ဖြင့် ပြည့်စုံသော Quark ERP workspace ကို scaffold လုပ်ပါသည်။ CLI က တရားဝင် template (https://github.com/TheParadance/quan-erp-node-template) ကို ဆွဲယူပါသည်။

  • new-project ကို ဗလာ directory မှ run ရပါမည်
  • plugins/ — သင့် module များကို ဤနေရာတွင် ဖန်တီးပါ (plugins/sample-es ကို ကြည့်ပါ)
  • base/ — docker-compose၊ available/installed plugin များ
  • .agents/ — AI အကူအညီဖြင့် တည်ဆောက်ရန် Quark ERP skill နှင့် rule များ
TSTerminal
mkdir my-quan-erp && cd my-quan-erp quan-erp new-project # optional: quan-erp new-project --version latest

4. Base app ကို စတင်ခြင်း

ပထမဆုံး စတင်မီ base/docker-compose.yaml ရှိ backend environment တွင် Firebase FCM အတွက် FIREBASE_CONFIG: '' ထည့်ပါ (local/dev အတွက် ဗလာ၊ push လိုအပ်မှသာ service-account JSON)။ ထို့နောက် project root မှ ဒေသခံ base Docker stack ကို စတင်ပါသည်။ ဤအဆင့်တွင် Postgres၊ Redis၊ backend နှင့် frontend တို့ ပေါ်လာပါသည်။

YAMLbase/docker-compose.yaml (backend environment)
FIREBASE_CONFIG: ''
TSTerminal
quan-erp base:dev # equivalent: docker compose -f base/docker-compose.yaml up -d

5. Plugin ကို ပြင်ဆင်ခြင်း

plugins/sample-es မှ ပုံစံများကို ကူးယူပါ၊ သို့မဟုတ် quan-erp new ဖြင့် scaffold လုပ်ပါ။ module.metadata.json ရှိ name သည် folder အမည်နှင့် တူညီရပါမည်။ Package အမည်များမှာ @quan-erp-plugins/<name>-backend|frontend ဖြစ်ရပါမည်။

6. CLI ဖြင့် build / watch လုပ်ခြင်း

Project root မှ watch သည် artifact များကို base/available-plugins/ သို့ sync လုပ်ပါသည်။

TSTerminal
quan-erp watch sample-es # or one-shot production build quan-erp build:prod sample-es

7. ဒေသခံ DB တွင် plugin မှတ်ပုံတင်ခြင်း

local/dev Postgres တွင်သာ module row ကို INSERT လုပ်ရပါမည် (credentials ကို base/backend/.env သို့မဟုတ် compose မှ ရယူပါ)။ UAT သို့မဟုတ် production တွင် seed မလုပ်ရပါ။

နောက်အဆင့်များ

  • Folder structure နှင့် CLI ကို ဖတ်ရှုပါ
  • ERP UI မှ plugin ကို Install လုပ်ပါ (installed-plugins သို့ ရောက်ရှိပါသည်)
  • Backend / Frontend Doc များကို ဆက်လက် ဖတ်ရှုပါ