🔒 開源閉鎖期公告
本專案是開源專案,沒錯!但目前正處於「閉鎖期」—— 想像一間試營運的餐廳:菜已經端得出來(APP 持續正常發佈),但三位主廚還在後廚激烈討論到底要不要把松露加進滷肉飯裡。
技術路線還沒最終拍板,我們每天都在優化架構,預計在 2.0 版正式開源。
等不及的朋友 —— 想在閉鎖期提供高見或擼起袖子一起開發,歡迎寫信到 ray@idempiere.dev,聊過之後我們會寄出邀請函。(對,就像霍格華茲入學通知,但不用等貓頭鷹 🦉)
歡迎加入開發團隊
iDempiere Mobile 是一個以 Flutter 打造的開源行動 ERP 客戶端,連接 iDempiere ERP 的 REST API。本指南協助您快速上手開發。
環境需求
| 項目 | 最低版本 | 說明 |
|---|---|---|
| Flutter SDK | 3.38+ | 穩定版頻道(stable channel) |
| Dart SDK | 3.7+ | 隨 Flutter SDK 附帶 |
| iDempiere | 11+ | 需安裝 idempiere-rest 外掛 |
| IDE | – | Android Studio 或 VS Code(含 Flutter/Dart 延伸模組) |
| Xcode | 15+ | 僅 iOS / macOS 建置需要 |
| Android Studio | Hedgehog+ | 僅 Android 建置需要 |
快速開始
# 1. 複製專案
git clone https://github.com/topgiga/tw.idempiere.flutter.git
cd tw.idempiere.flutter
# 2. 安裝依賴
flutter pub get
# 3. 產生程式碼(Freezed + json_serializable)
dart run build_runner build --delete-conflicting-outputs
# 4. 啟動應用
flutter run -d chrome # Web
flutter run -d macos # macOS
flutter run -d ios # iOS 模擬器
flutter run -d android # Android 模擬器
指南章節
技術棧一覽
🌐 English Version
🔒 Open Source — Currently in Stealth Mode
Yes, this is an open-source project! But we are currently in a “lockdown period” — think of it as a restaurant in soft-opening: the food is already being served (the APP keeps shipping), but three head chefs are still in the kitchen passionately debating whether to put truffle in the braised pork rice.
The technical roadmap has not been finalized — we are optimizing the architecture daily and plan to go fully open source at version 2.0.
Cannot wait? Want to share your wisdom or roll up your sleeves during the lockdown? Drop us a line at ray@idempiere.dev — after a chat, we will send you an invitation letter. (Yes, like a Hogwarts acceptance letter, but no owl required 🦉)
Welcome to the Team
iDempiere Mobile is an open-source Flutter mobile ERP client that connects to iDempiere ERP via its REST API. This guide will help you get started quickly.
Prerequisites
| Item | Minimum Version | Notes |
|---|---|---|
| Flutter SDK | 3.38+ | Stable channel |
| Dart SDK | 3.7+ | Bundled with Flutter SDK |
| iDempiere | 11+ | With idempiere-rest plugin |
| IDE | – | Android Studio or VS Code with Flutter/Dart extensions |
| Xcode | 15+ | Required for iOS / macOS builds only |
| Android Studio | Hedgehog+ | Required for Android builds only |
Quick Start
# 1. Clone the repo
git clone https://github.com/topgiga/tw.idempiere.flutter.git
cd tw.idempiere.flutter
# 2. Install dependencies
flutter pub get
# 3. Generate code (Freezed + json_serializable)
dart run build_runner build --delete-conflicting-outputs
# 4. Run the app
flutter run -d chrome # Web
flutter run -d macos # macOS
flutter run -d ios # iOS simulator
flutter run -d android # Android emulator
Guide Sections
Architecture Overview
Layer architecture, directory structure, Document Screen Framework, state management, routing, permission model.
Development Setup
Installation steps, project structure, code generation, debugging and testing guide.
Adding Features Guide
Three scenarios: config-driven document (10 min), custom screens, enterprise custom windows. The most important dev reference.
API Integration
iDempiere REST API authentication, CRUD, OData queries, document workflow, Callout field triggers, interceptors.
Deployment Guide
Platform builds, App Store publishing, Firebase push, R&D network restriction, macOS security, troubleshooting.
Menu & Screen Mapping
105+ features mapping: App Modules, DocumentRegistry, Enhanced Module Registry, feature visibility debugging.
R&D Module Technical Docs
25+ data tables, REST API contract, AI integration, PLM lifecycle, formula engine, Shake-to-Report.
🇯🇵 日本語版
🔒 オープンソース — 現在ステルスモード中
はい、これはオープンソースプロジェクトです!ただし現在「ロックダウン期間」中 —— ソフトオープン中のレストランだと思ってください:料理はちゃんと出ています(APPは通常通りリリース中)が、3人のシェフが厨房で「ルーローハンにトリュフを入れるべきか」を熱く議論中です。
技術ロードマップはまだ最終決定していません。毎日アーキテクチャを最適化中で、バージョン 2.0 で正式にオープンソース化する予定です。
待ちきれない方へ —— ロックダウン期間中にご意見をいただける方、一緒に開発したい方は ray@idempiere.dev までご連絡ください。お話しした後、招待状をお送りします。(ホグワーツの入学通知のように。ただしフクロウは不要です 🦉)
開発チームへようこそ
iDempiere Mobile は、iDempiere ERP の REST API に接続するオープンソースの Flutter モバイル ERP クライアントです。本ガイドでは、開発を素早く始めるための手順を解説します。
前提条件
| 項目 | 最低バージョン | 備考 |
|---|---|---|
| Flutter SDK | 3.38+ | Stable チャネル |
| Dart SDK | 3.7+ | Flutter SDK に同梱 |
| iDempiere | 11+ | idempiere-rest プラグインが必要 |
| IDE | – | Android Studio または VS Code(Flutter/Dart 拡張機能付き) |
| Xcode | 15+ | iOS / macOS ビルド時のみ必要 |
| Android Studio | Hedgehog+ | Android ビルド時のみ必要 |
クイックスタート
# 1. リポジトリをクローン
git clone https://github.com/topgiga/tw.idempiere.flutter.git
cd tw.idempiere.flutter
# 2. 依存パッケージをインストール
flutter pub get
# 3. コード生成(Freezed + json_serializable)
dart run build_runner build --delete-conflicting-outputs
# 4. アプリを起動
flutter run -d chrome # Web
flutter run -d macos # macOS
flutter run -d ios # iOS シミュレータ
flutter run -d android # Android エミュレータ