Flutter — Installation

Requirements

Flutter >=3.0.0
Dart >=3.0.0

iOS requirements

Device with iOS 12+, iPadOS 12+, or Xcode simulator running iOS 16.2+
Swift Package Manager (requires opt-in) or CocoaPods 1.16.2+

Android requirements

Android 7.0+ device or emulator with Google Play Store (Services) installed

1. Add the dependency

Add atelerix_flutter to your pubspec.yaml:

pubspec.yaml

dependencies:
  atelerix_flutter: ^1.0.0

Then run:

flutter pub get

2. Initialize the SDK

Call Atelerix.init() as early as possible — ideally at the top of main() in main.dart. Initialization sets up error monitoring and reporting. It does not initialize push notifications; call Atelerix.notifications.init() separately when you need that module.

main.dart

import 'package:atelerix_flutter/atelerix_flutter.dart';

void main() {
  Atelerix.init(
    url: 'https://api.atelerix.dev',
    apiKey: 'your-api-key',
    projectId: 'your-project-id',
    builder: () => runApp(const MyApp()),
  );
}

Find your API key and project ID in the Atelerix Dashboard under Project Settings.

Parameters

Parameter	Type	Required	Description
`url`	`String`	Yes	Your project URL (e.g. `https://api.atelerix.dev`)
`apiKey`	`String`	Yes	Your project API key from the dashboard
`projectId`	`String`	Yes	Your project ID from the dashboard
`builder`	`Function`	Yes	Function that calls `runApp()` to start your app
`debugMode`	`bool`	No	Enable debug logging (default: `false`)
`onError`	`Function`	No	Custom error handler called when an error is captured

Async initialization

If your builder needs async setup before runApp(), call WidgetsFlutterBinding.ensureInitialized() first:

main.dart

void main() {
  Atelerix.init(
    url: 'https://api.atelerix.dev',
    apiKey: 'your-api-key',
    projectId: 'your-project-id',
    builder: () async {
      WidgetsFlutterBinding.ensureInitialized();
      await loadConfig();
      runApp(const MyApp());
    },
  );
}

Debug mode

Set debugMode: true during development to print SDK logs to the console:

main.dart

Atelerix.init(
  url: 'https://api.atelerix.dev',
  apiKey: 'your-api-key',
  projectId: 'your-project-id',
  debugMode: true,
  builder: () => runApp(const MyApp()),
);

Custom error handler

Use onError to run your own logic when the SDK captures an error — for example, showing a fallback UI or logging to a secondary service:

main.dart

Atelerix.init(
  url: 'https://api.atelerix.dev',
  apiKey: 'your-api-key',
  projectId: 'your-project-id',
  builder: () => runApp(const MyApp()),
  onError: (error) {
    print('Custom error handler: ${error.message}');
  },
);

3. Verify the integration

Throw a test error to confirm everything is working:

main.dart

await Atelerix.throwError(
  Exception('Test error'),
  StackTrace.current,
);

Then open your dashboard — the error should appear within seconds.

You’re all set! Continue to Error Tracking to report custom errors, or Push Notifications to enable push delivery.

Getting Started

Frameworks

Modules

Developers

Flutter — Installation

Requirements

iOS requirements

Android requirements

1. Add the dependency

2. Initialize the SDK

Parameters

Async initialization

Debug mode

Custom error handler

3. Verify the integration

​Requirements

​iOS requirements

​Android requirements

​1. Add the dependency

​2. Initialize the SDK

​Parameters

​Async initialization

​Debug mode

​Custom error handler

​3. Verify the integration

Requirements

iOS requirements

Android requirements

1. Add the dependency

2. Initialize the SDK

Parameters

Async initialization

Debug mode

Custom error handler

3. Verify the integration