Demo

CLI

@quan-erp/cli ကို npm မှ သွင်းပြီး၊ project နှင့် plugin scaffold လုပ်ခြင်း၊ watch build၊ production pack ထုတ်ခြင်း၊ နှင့် ဒေသခံ base Docker stack စတင်ခြင်းတို့ကို လုပ်ဆောင်နိုင်ပါသည်။ Command များကို Quark ERP project ၏ root မှ run ရပါသည် (new-project အတွက် ဗလာ folder ကို အသုံးပြုပါ)။

သွင်းခြင်း

တရားဝင် CLI ကို npm ပေါ်တွင် @quan-erp/cli အဖြစ် ထုတ်ဝေထားပါသည်။ Node.js 18+ လိုအပ်ပါသည်။ သွင်းပြီးနောက် quan-erp သည် အဓိက command ဖြစ်ပြီး၊ quark-erp နှင့် erp တို့မှာ တူညီသော CLI အတွက် alias များ ဖြစ်ပါသည်။

  • npm i -g @quan-erp/cli — ကမ္ဘာလုံးဆိုင်ရာ (global) သွင်းခြင်း
  • quan-erp — အဓိက command
  • quark-erp / erp — တူညီသော CLI အတွက် alias များ
SHinstall
npm i -g @quan-erp/cli
npm ပေါ်ရှိ @quan-erp/cli →

Command များ

ဖော်ပြထားခြင်း မရှိပါက Quark ERP project root မှ အသုံးပြုပါ။ new / new-plugin / new-project တွင် optional --version <tag> ဖြင့် template ဗားရှင်းကို ရွေးနိုင်ပြီး၊ ပုံသေမှာ latest ဖြစ်ပါသည်။

Commandဖော်ပြချက်
quan-erp version / -v / --versionCLI ဗားရှင်းကို ပြသပါသည်
quan-erp new / new-pluginတရားဝင် template မှ plugin scaffold လုပ်ပါသည်
quan-erp new-projectProject template ကို လက်ရှိ directory သို့ clone လုပ်ပါသည်
quan-erp watch <plugin>Development အတွက် watch လုပ်ပြီး ပြန်လည် တည်ဆောက်ပါသည်
quan-erp build:prod <plugin>Production build → base/available-plugins/
quan-erp pack:prod <plugin>Production build နှင့်အတူ zip archive ထုတ်ပါသည်
quan-erp base:devBase stack ကို စတင်ပါသည် (docker compose -f base/docker-compose.yaml up -d)
quan-erp helpအသုံးပြုပုံကို ပြသပါသည်
TShelp
quan-erp help

new-project

တရားဝင် template မှ ပြည့်စုံသော Quark ERP project တစ်ခုကို လက်ရှိ directory သို့ scaffold လုပ်ပါသည်။ ဗလာ folder တွင် အသုံးပြုပါ။

TSnew-project
quan-erp new-project quan-erp new-project --version latest

new / new-plugin

plugins/ အောက်တွင် plugin တစ်ခုကို အပြန်အလှန် (interactive) scaffold လုပ်ပါသည်။ အမည်နှင့် ဆက်စပ် metadata ကို မေးမြန်းပြီး၊ တရားဝင် template မှ plugin ကို ဖန်တီးပေးပါသည်။

TSnew plugin
quan-erp new quan-erp new-plugin quan-erp new-plugin --version latest

watch

နေ့စဉ် အဓိက အသုံးပြုရသော command ဖြစ်ပါသည်။ Plugin ကို development အတွက် ပြန်လည် တည်ဆောက်ပြီး၊ artifact များကို base/available-plugins/<name>/<version>/ သို့ sync လုပ်ပါသည် (ထည့်သွင်းပြီးသား ဖြစ်ပါက installed-plugins သို့လည်း ရောက်ပါသည်)။

  • Argument — plugins/ အောက်ရှိ folder အမည် (module.metadata.json ရှိ name နှင့် တူရပါမည်)
  • plugins/ နှင့် base/ မှန်ကန်စွာ ရှာတွေ့နိုင်ရန် project root မှ run ရပါသည်
TSwatch
quan-erp watch sample-es

build:prod နှင့် pack:prod

build:prod သည် production အတွက် compile လုပ်ပြီး available-plugins သို့ ရေးသားပါသည်။ ဖြန့်ဝေရန် zip archive လိုအပ်သည့်အခါ pack:prod ကို အသုံးပြုပါ။

TSbuild & pack
quan-erp build:prod sample-es quan-erp pack:prod sample-es

base:dev

Project root မှ ဒေသခံ base Docker stack ကို စတင်ပါသည်။

TSbase:dev
quan-erp base:dev # equivalent: docker compose -f base/docker-compose.yaml up -d

Output ဖွဲ့စည်းပုံ

Watch နှင့် production build များသည် ဗားရှင်းပါ artifact များကို available-plugins အောက်တွင် ထားရှိပါသည်။ ERP UI မှ install လုပ်သောအခါ plugin ကို installed-plugins အောက်တွင် အသက်ဝင်စေပါသည်။

SHpaths
1base/available-plugins/<plugin-name>/<version>/ 2├── backend/ 3├── frontend/ 4└── module.metadata.json 5 6base/backend/installed-plugins/<plugin-name>/ 7├── backend/ 8├── frontend/ 9└── module.metadata.json

အကြံပြုချက်များ

  • Repo root ရှိ အဟောင်း ./erp binary ထက် npm ပေါ်ရှိ @quan-erp/cli ကို ဦးစားပေး အသုံးပြုပါ
  • Project root မှ run ပါ — watch / build / pack အတွက် plugins/ နှင့် base/ ဆိုသော relative path များ လိုအပ်ပါသည်
  • module.metadata.json ရှိ pluginVersion သည် available-plugins အောက်ရှိ version folder ဖြစ်လာပါသည်
  • UI တွင် ပြောင်းလဲမှု မပေါ်ပါက available-plugins နှင့် installed-plugins နှစ်ခုလုံးတွင် plugin ရှိမရှိ စစ်ဆေးပါ
  • quan-erp help ဖြင့် သင့် CLI က ပံ့ပိုးသော command စာရင်းကို ကြည့်နိုင်ပါသည်
  • Package စာမျက်နှာ — https://www.npmjs.com/package/@quan-erp/cli