Quickstart

This guide gets you from a blank Flutter project to submitting your first Traceway report. Estimated time: 5 to 10 minutes.

Prerequisites

• Flutter >=3.27.0 and Dart ^3.6.0 installed
• A Traceway account at traceway.dev
• A project created in the Traceway dashboard with an API key ready

Step 1 — Add the dependency

Open your pubspec.yaml and add:

dependencies:
  traceway:
    git:
      url: https://github.com/tracewaydev/traceway-flutter

Run:

flutter pub get

Step 2 — Initialize the SDK

In your main.dart, initialize Traceway before runApp:

import 'package:flutter/material.dart';
import 'package:traceway/traceway.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  await Traceway.initialize(
    apiKey: 'YOUR_API_KEY',
  );

  runApp(const MyApp());
}

Replace YOUR_API_KEY with the key from your Traceway project settings.

Step 3 — Run your app

flutter run

Step 4 — Submit a test report

With the app running, shake your device (or the simulator). The Traceway report sheet will appear. Fill in a title and submit.

Step 5 — View it in the dashboard

Open traceway.dev, navigate to your project, and open the Issues tab. Your test report should appear within a few seconds.

What happens automatically

Every report submitted through the Traceway sheet includes:

• Device model and OS version (via device_info_plus)
• App version and build number (via package_info_plus)
• The platform (iOS, Android, Web, or desktop)
• A unique report ID

No additional configuration is needed for this metadata — it is captured automatically at the moment of submission.

Next steps

• Full Flutter SDK guide — shake sensitivity, floating button, custom trigger, crash reporting
• Configuration options — environments, user identity, custom metadata
• API Reference — submit reports programmatically from your own code