Flutter AdminPanel

A comprehensive Flutter admin panel library inspired by react-admin, with a universal adapter system for any data source.

📚 Documentation

Read the full documentation on GitBook →

✨ Features

• 🎨 Modern UI - Clean, Material Design 3 interface
• 🔌 Universal Adapters - Connect to any data source with REST API
• 🔧 Plug-and-Play - No forced dependencies, use only what you need
• 🗓️ Event Management - Complete event lifecycle with automatic status updates
• 📱 Cross-Platform - Works on Web, Mobile, and Desktop
• 🔒 Type Safe - Written in Dart with strong typing
• ⚡ High Performance - Optimized for large datasets
• 🌐 Offline Support - Built-in caching and sync
• 🎯 Production Ready - Battle-tested in real-world applications

🚀 Quick Links

• Installation Guide - Get started in 5 minutes
• Quick Start - Build your first admin panel
• Adapters Guide - Connect to any data source
• API Reference - Complete API documentation
• Examples - Working example application

📦 Supported Data Sources

Built-in (No Extra Dependencies)

• ✅ REST API - Works with any RESTful backend

📦 Installation

dependencies:
  flutter_adminpanel: ^1.4.1

flutter pub get

📖 Full Installation Guide →

⚡ Quick Start

Step 1: Choose Your Data Provider

import 'package:flutter/material.dart';
import 'package:flutter_adminpanel/flutter_adminpanel.dart';
import 'package:flutter_adminpanel/adapters/rest.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  
  // Register REST API provider
  final provider = await registerRestProvider(
    baseUrl: 'https://api.example.com',
  );
  
  runApp(MyAdminApp(provider: provider));
}

Step 2: Build Your Admin Panel

class MyAdminApp extends StatelessWidget {
  final DataProvider provider;
  
  const MyAdminApp({Key? key, required this.provider}) : super(key: key);
  
  @override
  Widget build(BuildContext context) {
    return AdminApp(
      title: 'My Admin Panel',
      dataProvider: provider,
      resources: [
        Resource(
          name: 'products',
          list: ProductListScreen(),
          create: ProductCreateScreen(),
          edit: ProductEditScreen(),
        ),
      ],
    );
  }
}

Step 3: Define Your Resource

class ProductListScreen extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return ResourceList(
      resource: 'products',
      columns: [
        ColumnConfig(field: 'id', label: 'ID', width: 80),
        ColumnConfig(field: 'name', label: 'Name', sortable: true),
        ColumnConfig(
          field: 'price',
          label: 'Price',
          sortable: true,
          format: (value) => '\$${value.toStringAsFixed(2)}',
        ),
      ],
    );
  }
}

📖 Complete Quick Start Guide →

🔌 Universal Adapter System

Connect to any data source without adding unnecessary dependencies:

// REST API
import 'package:flutter_adminpanel/adapters/rest.dart';
final provider = await registerRestProvider(baseUrl: 'https://api.example.com');

📖 Full Adapters Guide →

📚 Documentation

Getting Started

• Installation - Setup guide
• Quick Start - Build your first admin panel
• Core Concepts - Architecture overview

Data Providers

• Adapters Guide - Universal adapter system
• REST API - Generic REST API support
• Custom Providers - Create your own

Features

• Event Management - Lifecycle management
• Onboarding System - User onboarding
• Analytics - Charts and dashboards
• Offline Mode - Caching and sync

Reference

• API Reference - Complete API docs
• Configuration - All config options
• Troubleshooting - Common issues
• Changelog - Version history

🎯 Example Application

See the example directory for a complete admin panel with:

• REST API data provider
• Event management
• Onboarding flow
• File uploads

View Example →

🧪 Testing

# Run unit tests
flutter test

# Run integration tests
cd example
flutter test integration_test/

🏗️ Architecture

AdminApp
├── Data Provider Registry (Adapter System)
│   ├── REST API Adapter
│   └── Custom Adapters
├── Resources
│   ├── List View
│   ├── Create Form
│   ├── Edit Form
│   └── Show View
└── Services
    ├── Event Management
    ├── Offline Storage
    └── File Handling

Read Architecture Guide →

🔄 Comparison with react-admin

Feature	react-admin	flutter_adminpanel
Framework	React (Web)	Flutter (Cross-platform)
Language	JavaScript/TypeScript	Dart
Data Providers	Multiple	Universal Adapter System
UI Components	Material-UI	Material Design 3
Platform	Web only	Web, Mobile, Desktop
Type Safety	TypeScript	Dart (built-in)
Offline Support	Limited	Built-in with RADA

🤝 Contributing

We welcome contributions! See our GitHub repository for:

• Contributing Guidelines
• Code of Conduct
• Issue Tracker

📄 License

MIT License - see LICENSE file for details.

📞 Support

• GitHub Issues
• Stack Overflow
• Documentation

---

Made with ❤️ by NativeMind