THE ULTIMATE – Installation Guide

The Ultimate – Installation Guide #

This guide will walk you through installing the Ultimate Desktop Connector module for UltimatePOS, and configuring the Flutter app to connect and function correctly.

🔧 Step 1: Enable the Connector Module #

1. Access your server via the hosting panel or FTP.
2. Navigate to the root directory of your UltimatePOS installation.
3. Open the file: modules_statuses.json
4. Add the following line inside the JSON structure:

"UltimateDesktopConnetor": true

Note: Make sure the JSON remains valid (comma placement, etc.).

🔐 Step 2: Allow API Access #

1. Open the file: app/Http/Middleware/VerifyCsrfToken.php
2. Add this line inside the $except array:

'desktopapi/api/*',

Example:

protected $except = [
  'desktopapi/api/*',
  '/install/details',
  '/api/ecom/orders',
  // ... other exceptions
];

📦 Step 3: Upload the Module #

1. Log in to your UltimatePOS Admin Panel
2. Go to: Modules > Upload Module
3. Upload the file: ultimate_desktop_connector.zip
4. Activate the module using your license key if prompted
5. Once installed, it will appear in the sidebar

🔑 Step 4: Create API Client Credentials #

1. From the sidebar, go to Clients
2. Click Add Client
3. Enter a name (e.g. Ultimate Desktop – Store 1)
4. After saving, copy the generated:
   • Client ID
   • Client Secret

⚙️ Step 5: Configure the App #

Instead of using an .env file, configuration is handled in:

lib/core/config/app_config.dart

Open the file and update the AppConfig class:

class AppConfig {
  static const Map defaults = {
    'OAUTH_CLIENT_ID': 'YOUR_OAUTH_CLIENT_ID',
    'OAUTH_CLIENT_SECRET': 'YOUR_OAUTH_CLIENT_SECRET',
    'OAUTH_BASE_URL': 'https://your-pos-url.com',
    'APP_NAME': 'Ultimate POS Suite',
    'APP_VERISON': '1.0.0',
    'PURCHASE_CODE': 'XXXX-XXXX-XXXX-XXXX',
    'COPYRIGHT_NOTICE': '© 2025 DevMosaic',
  };
}

Tips:

• OAUTH_BASE_URL must be a secure HTTPS link
• Enter your CodeCanyon purchase code in PURCHASE_CODE

🏁 Step 6: Run the App #

Use your terminal to fetch dependencies and run the app:

flutter pub get
flutter run -d windows   # or android, ios, macos, etc.

Done! Your desktop app is now connected to your UltimatePOS system.

📩 Support #

Need help or have questions? Reach out via:

• Email: devmosaicclub@gmail.com