Skip to main content

Installation

Get started with Appikorn Madix Widgets in your Flutter project.

Prerequisites​

Before installing Appikorn Madix Widgets, ensure you have:

  • Flutter SDK 3.0.0 or higher
  • Dart SDK 2.17.0 or higher
  • A Flutter project set up and ready

Installation Methods​

Add Appikorn Madix Widgets to your pubspec.yaml file:

dependencies:
  flutter:
    sdk: flutter
  appikorn_madix_widgets: ^1.0.0

Then run:

flutter pub get

Method 2: Git Dependency​

If you want to use the latest development version:

dependencies:
  appikorn_madix_widgets:
    git:
      url: https://github.com/appikorn/madix-widgets.git
      ref: main

Method 3: Local Path​

For local development or custom modifications:

dependencies:
  appikorn_madix_widgets:
    path: ../path/to/appikorn_madix_widgets

Import the Package​

After installation, import the package in your Dart files:

import 'package:appikorn_madix_widgets/appikorn_madix_widgets.dart';

Verify Installation​

Create a simple test to verify the installation:

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

class TestWidget extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text('Appikorn Test')),
      body: Center(
        child: TextAppi(
          text: 'Appikorn Madix Widgets is working!',
          style: TextStyle(
            fontSize: 18,
            fontWeight: FontWeight.bold,
            color: Colors.blue,
          ),
        ),
      ),
    );
  }
}

Dependencies​

Appikorn Madix Widgets includes the following dependencies:

dependencies:
  flutter:
    sdk: flutter
  cupertino_icons: ^1.0.2
  flutter_quill: ^9.4.4
  flutter_quill_extensions: ^9.4.4
  fl_chart: ^0.66.2
  http: ^1.1.2
  shared_preferences: ^2.2.2

These will be automatically installed when you add Appikorn Madix Widgets to your project.

Platform Support​

Appikorn Madix Widgets supports all Flutter platforms:

  • ✅ Android (API 21+)
  • ✅ iOS (iOS 11.0+)
  • ✅ Web (Chrome, Firefox, Safari, Edge)
  • ✅ macOS (macOS 10.14+)
  • ✅ Windows (Windows 10+)
  • ✅ Linux (Ubuntu 18.04+)

Troubleshooting​

Common Issues​

1. Version Conflicts​

If you encounter version conflicts, try:

flutter pub deps
flutter pub upgrade

2. Import Errors​

Make sure you've run flutter pub get after adding the dependency.

3. Build Errors​

Clean and rebuild your project:

flutter clean
flutter pub get
flutter run

Getting Help​

If you encounter issues:

  1. Check our GitHub Issues
  2. Join our Discord Community
  3. Check the documentation for more details

Next Steps​

Now that you have Appikorn Madix Widgets installed:

  1. Set up your theme for consistent styling
  2. Explore the widget gallery to see all available components
  3. Check out examples for real-world usage patterns

Ready to start building? Let's set up theming for your app!