Quickstart

Two installs: Control on your Frappe bench, the SDK in your Flutter app.

1. Install Control on your bench

bench get-app https://github.com/dhwani-ris/frappe-mobile-control
bench --site yoursite install-app mobile_control
bench --site yoursite migrate

2. Add the SDK to your Flutter app

flutter pub add frappe_mobile_sdk

3. Point the SDK at your server

final sdk = FrappeSDK(baseUrl: 'https://yoursite.example.com/');
await sdk.initialize(true);

baseUrl needs the trailing slash. Login, document lists, forms and sync status are available as ready-made screens.

4. Configure the app in the desk

Open Mobile Configuration in the desk (System Manager only).

1. Tick Enabled.
2. Fill in Package Name and Minimum App Version.
3. Add the doctypes the app should show to Forms Configuration.
4. Tick Offline Mode Enabled only for offline-first deployments.
5. Save.

Next

Requirements covers supported versions. The SDK 2.0 guide covers the offline-first rollout in full.