開發者指南

開發者指南
加入 iDempiere Mobile Flutter 專案的完整開發參考手冊

歡迎加入開發團隊

iDempiere Mobile 是一個以 Flutter 打造的開源行動 ERP 客戶端,連接 iDempiere ERP 的 REST API。本指南協助您快速上手開發。

環境需求

項目 最低版本 說明
Flutter SDK 3.22+ 穩定版頻道(stable channel)
Dart SDK 3.4+ 隨 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/anthropics/idempiere-mobile.git
cd idempiere-mobile

# 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 模擬器

指南章節

架構概述

分層架構、目錄結構、文件畫面框架(Document Screen Framework)、狀態管理、路由、權限模型。

閱讀章節 →

開發環境設定

安裝步驟、專案結構、程式碼產生、除錯與測試的完整指引。

閱讀章節 →

新增功能指南

三種場景:設定驅動文件(10 分鐘)、自訂畫面、企業自訂視窗。最重要的開發參考。

閱讀章節 →

API 整合

iDempiere REST API 認證、CRUD、OData 查詢、文件工作流程、攔截器、批次操作。

閱讀章節 →

部署指南

各平台建置、App Store 上架、白牌設定、Firebase 推播、疑難排解。

閱讀章節 →

技術棧一覽

Flutter 3.22+
Dart 3.4+
Riverpod
GoRouter
Dio
Freezed
Material Design 3
Firebase
🌐 English Version
Developer Guide
Complete development reference for the iDempiere Mobile Flutter project

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.22+ Stable channel
Dart SDK 3.4+ 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/anthropics/idempiere-mobile.git
cd idempiere-mobile

# 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.

Read Section →

Development Setup

Installation steps, project structure, code generation, debugging and testing guide.

Read Section →

Adding Features Guide

Three scenarios: config-driven document (10 min), custom screens, enterprise custom windows. The most important dev reference.

Read Section →

API Integration

iDempiere REST API authentication, CRUD, OData queries, document workflow, interceptors, batch operations.

Read Section →

Deployment Guide

Platform builds, App Store publishing, white-label config, Firebase push notifications, troubleshooting.

Read Section →

Flutter 3.22+
Dart 3.4+
Riverpod
GoRouter
Dio
Freezed
Material Design 3
Firebase