Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@


# Flutter Admin Dashboard

A cross-platform admin dashboard application built with Flutter. This project supports Android, iOS, macOS, Web, and Windows, providing a responsive and feature-rich interface for administrative tasks.

## Features
- 📊 Data visualization and charting using `fl_chart`
- 🖼️ Scalable vector graphics support with `flutter_svg`
- 🎨 Custom typography via `google_fonts`
- 🔄 Lightweight state management using `provider`
- 🌐 Multi-platform support (Android, iOS, macOS, Web, Windows)
- ⚡ Optimized web loading screen with custom CSS animations and PWA support

## Installation

### Prerequisites
- [Flutter SDK](https://flutter.dev/docs/get-started/install) (`>=2.12.0 <3.0.0`)
- A supported IDE (VS Code, Android Studio, or Xcode)
- Platform-specific tools (Android Studio/SDK, Xcode for macOS/iOS, etc.)

### Setup
1. Clone the repository:
```bash
git clone https://github.com/Abjithwyn/flutter-admin-dashboard.git
cd flutter-admin-dashboard
```
2. Install project dependencies:
```bash
flutter pub get
```

## Usage

Run the application on your desired platform using the Flutter CLI:

```bash
# Run on Web (Chrome)
flutter run -d chrome

# Run on Android
flutter run -d android

# Run on iOS
flutter run -d ios

# Run on macOS
flutter run -d macos

# Run on Windows
flutter run -d windows
```

## Project Structure
This repository follows the standard Flutter project layout. Key directories include:
- `assets/`: Contains images and icons used in the dashboard.
- `android/`, `ios/`, `macos/`, `windows/`, `web/`: Platform-specific configurations, native code, and manifest files.
- `pubspec.yaml`: Project metadata, versioning, and dependency management.

## Dependencies
- `flutter`: SDK
- `provider`: ^6.0.5
- `fl_chart`: ^0.62.0
- `flutter_svg`: ^2.0.5
- `google_fonts`: ^4.0.4
- `cupertino_icons`: ^1.0.3

## License
[Add your license information here]