Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/aliammari1/readrealm/llms.txt

Use this file to discover all available pages before exploring further.

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

cd apps/dashboard
flutter pub get
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:
cd apps/dashboard
flutter run -d chrome
Task equivalent:
task dashboard:run

​
Build for production

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.

​
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

Build docs developers (and LLMs) love

Get started for freeTalk to us