Admin Dashboard Setup

Install and run the ReadRealm Flutter admin dashboard on web, Windows, or macOS.

The admin dashboard is a Flutter application that runs on web (Chrome), Windows, and macOS. It provides a management interface for users, books, and library analytics.

Prerequisites

• Flutter SDK 3.20+
• Dart SDK 3.4+ (bundled with Flutter)

Verify your Flutter installation:

flutter --version
flutter doctor

flutter doctor will report any missing dependencies for your target platform.

---

Setup

1. Clone the repository

   git clone https://github.com/aliammari1/readrealm.git
   cd readrealm
   
2. Install dependencies

   Flutter

   cd apps/dashboard
   flutter pub get
   

   Task

   task dashboard:install
   

   This installs all packages listed in apps/dashboard/pubspec.yaml, including provider, http, google_fonts, fl_chart, flutter_secure_storage, and others.

3. Configure the API URL

   The dashboard connects to the ReadRealm backend. The base URL is set in apps/dashboard/lib/providers/auth_provider.dart:

   apps/dashboard/lib/providers/auth_provider.dart

   final String _baseUrl = 'https://libraryapp-nest-back.vercel.app';
   

   To connect to a local API server, update _baseUrl to point to your machine:

   final String _baseUrl = 'http://localhost:3000';
   

   The book service URL is configured separately in apps/dashboard/lib/services/book_service.dart:

   apps/dashboard/lib/services/book_service.dart

   static const String baseUrl = 'http://localhost:3000/book';
   
4. Run the dashboard

   Choose a target platform:

   Web (Chrome)

   cd apps/dashboard
   flutter run -d chrome
   

   Task equivalent:

   task dashboard:run
   

   macOS

   cd apps/dashboard
   flutter run -d macos
   

   Task equivalent:

   task dashboard:run:macos
   

   Windows

   cd apps/dashboard
   flutter run -d windows
   

   Task equivalent:

   task dashboard:run:windows
   

---

Build for production

Web

cd apps/dashboard
flutter build web

Task equivalent:

task dashboard:build:web

The output is placed in apps/dashboard/build/web/. Deploy the contents of this directory to any static web host.

Windows

cd apps/dashboard
flutter build windows

Task equivalent:

task dashboard:build:windows

The compiled executable is output to apps/dashboard/build/windows/runner/Release/.

---

Run tests

cd apps/dashboard
flutter test

Task equivalent:

task dashboard:test

---

Troubleshooting

flutter doctor reports missing dependencies

Run flutter doctor and follow its instructions for your target platform. For web, no additional setup is required beyond the Flutter SDK. For desktop builds, you may need to install platform-specific toolchains (Visual Studio Build Tools on Windows, Xcode on macOS).

Clean and reinstall after dependency errors

cd apps/dashboard
flutter clean
flutter pub get
flutter run