Main installation walkthrough

Install the backend first, then configure and test the mobile app. Use a staging CRM and test customer wherever possible.

1. Prepare the CRM

Back up your files and database. Confirm that the customer portal works over HTTPS and that you can sign in with an active customer contact. Record the CRM installation URL, including any subdirectory.

2. Install the API module

Install the supplied flutex_customer_api module in Perfex and activate it. Complete license activation at:

<CRM URL>/admin/flutex_customer_api/flutex_customer_api_license

Request <CRM URL>/flutex_customer_api/v1/config and confirm that it returns JSON rather than an HTML page. A successful public config request does not prove that the protected API license is active.

3. Configure the app

Extract the Flutter source. In lib/app/constants.dart, set Constants.baseUrl to your CRM installation URL without a trailing slash. Do not append the API path: the Dio configuration already adds it.

Configure your final application identifiers and Firebase project using the Firebase articles. The current app initializes Firebase during startup, so this setup is part of running the supplied source.

4. Prepare and run

From the project root, run:

flutter doctor -v
flutter pub get
flutter devices
flutter run

If generated files are missing or you changed annotated models/providers, run the code-generation command documented in Fixing Flutter Build Errors.

5. Verify

Sign in, inspect a customer record, test a PDF, and submit a test ticket. Complete Verifying Your Installation before applying extensive customizations or publishing a release.

Write Your Comment