🎓 CampusQuest

Modern Campus Management System

A comprehensive, feature-rich campus management solution built with Flutter

Features • Screenshots • Installation • Architecture • Contributing

📋 Table of Contents

About
Features
Screenshots
Tech Stack
Installation
Project Structure
Architecture
Configuration
Usage
Contributing
License
Contact

🎯 About

CampusQuest is a modern, cross-platform campus management system designed to streamline educational institution operations. Built with Flutter and powered by Supabase, it provides a unified platform for students, instructors, and administrators to manage academic activities efficiently.

Why CampusQuest?

🚀 Modern UI/UX - Beautiful, intuitive interface with dark mode support
📱 Cross-Platform - Works seamlessly on Android, iOS, Web, and Desktop
🔐 Secure - Built-in authentication and role-based access control
⚡ Real-time - Live updates powered by Supabase
🎨 Customizable - Flexible theming and personalization options
📊 Analytics - Comprehensive data visualization and reporting

✨ Features

👨‍🎓 For Students

📚 Course Management - View enrolled courses, schedules, and materials
📝 Assignment Tracking - Submit assignments and track deadlines
📊 Grade Monitoring - Real-time access to grades and performance analytics
📅 Attendance - View attendance records and statistics
💬 Communication - Direct messaging with instructors and peers
📄 Document Management - Access and download course materials

👨‍🏫 For Instructors

📖 Course Creation - Create and manage courses with ease
👥 Student Management - Track student progress and performance
📝 Assignment Management - Create, distribute, and grade assignments
📊 Analytics Dashboard - Comprehensive insights into class performance
📢 Announcements - Broadcast important updates to students
📁 Resource Sharing - Upload and share course materials

👨‍💼 For Administrators

🏢 Institution Management - Manage departments, courses, and users
📊 Comprehensive Reports - Generate detailed analytics and reports
👤 User Management - Create and manage user accounts and roles
📈 Performance Tracking - Monitor institutional performance metrics
🔧 System Configuration - Customize system settings and preferences
📋 Audit Logs - Track system activities and changes

🎨 General Features

🌓 Dark/Light Mode - Eye-friendly themes for any environment
🔔 Push Notifications - Stay updated with real-time alerts
📱 Responsive Design - Optimized for all screen sizes
🔍 Advanced Search - Quickly find courses, students, or materials
📥 Export Options - Download data in PDF, CSV formats
🌐 Multi-language Support - (Coming Soon)

🛠 Tech Stack

Frontend

Framework: Flutter 3.2.0+
Language: Dart 3.2.0+
State Management: Provider
UI Components: Material Design 3

Backend

BaaS: Supabase
Authentication: Supabase Auth
Database: PostgreSQL (via Supabase)
Storage: Supabase Storage
Real-time: Supabase Realtime

Key Dependencies

dependencies:
  flutter: sdk
  supabase_flutter: ^2.8.4      # Backend integration
  provider: latest               # State management
  google_fonts: ^6.2.1          # Typography
  fl_chart: ^0.65.0             # Data visualization
  cached_network_image: ^3.2.0  # Image caching
  flutter_animate: ^1.0.0       # Animations
  pdf: ^3.11.3                  # PDF generation
  printing: ^5.14.2             # PDF printing
  file_picker: ^8.0.0           # File selection
  image_picker: ^0.8.4+4        # Image selection
  permission_handler: ^11.3.1   # Permissions
  url_launcher: ^6.0.6          # External links
  intl: ^0.20.2                 # Internationalization

📥 Installation

Prerequisites

Flutter SDK (3.2.0 or higher)
Dart SDK (3.2.0 or higher)
Android Studio / Xcode (for mobile development)
Git

Step 1: Clone the Repository

git clone https://github.com/yourusername/campusquest.git
cd campusquest

Step 2: Install Dependencies

flutter pub get

Step 3: Configure Supabase

Create a Supabase project at supabase.com
Update the Supabase credentials in lib/main.dart:

await Supabase.initialize(
  url: 'YOUR_SUPABASE_URL',
  anonKey: 'YOUR_SUPABASE_ANON_KEY',
);

Step 4: Run the Application

# For development
flutter run

# For specific platform
flutter run -d chrome        # Web
flutter run -d android       # Android
flutter run -d ios           # iOS
flutter run -d windows       # Windows
flutter run -d macos         # macOS
flutter run -d linux         # Linux

Step 5: Build for Production

# Android APK
flutter build apk --release

# Android App Bundle
flutter build appbundle --release

# iOS
flutter build ios --release

# Web
flutter build web --release

# Windows
flutter build windows --release

📁 Project Structure

campusquest/
├── lib/
│   ├── main.dart                 # Application entry point
│   ├── controllers/              # Business logic controllers
│   │   ├── login_controller.dart
│   │   └── theme_controller.dart
│   ├── modules/                  # Feature modules
│   │   ├── admin/               # Admin module
│   │   ├── instructor/          # Instructor module
│   │   ├── student/             # Student module
│   │   └── login/               # Authentication module
│   ├── widgets/                 # Reusable widgets
│   │   ├── bottomnavigationbar.dart
│   │   └── splash_screen.dart
│   ├── theme/                   # Theme configuration
│   └── Data/                    # Data models and services
├── assets/                      # Images, fonts, etc.
├── android/                     # Android-specific files
├── ios/                         # iOS-specific files
├── web/                         # Web-specific files
├── windows/                     # Windows-specific files
├── linux/                       # Linux-specific files
├── macos/                       # macOS-specific files
├── test/                        # Unit and widget tests
├── pubspec.yaml                 # Dependencies
└── README.md                    # This file

🏗 Architecture

CampusQuest follows a modular architecture with clear separation of concerns:

Design Pattern

MVC (Model-View-Controller) - For business logic separation
Provider Pattern - For state management
Repository Pattern - For data access abstraction

Module Structure

Each module (Admin, Instructor, Student) contains:

Views - UI components
Controllers - Business logic
Models - Data structures
Services - API interactions

Data Flow

User Interaction → Controller → Service → Supabase → Service → Controller → View Update

⚙️ Configuration

Environment Variables

Create a .env file in the root directory:

SUPABASE_URL=your_supabase_url
SUPABASE_ANON_KEY=your_supabase_anon_key

Theme Customization

Modify lib/theme/theme.dart to customize colors, fonts, and styles.

Firebase (Optional)

For push notifications, configure Firebase:

Add google-services.json (Android)
Add GoogleService-Info.plist (iOS)

🚀 Usage

Running in Development Mode

flutter run

Running with Device Preview

The app includes Device Preview for testing multiple screen sizes:

// Enabled by default in main.dart
DevicePreview(
  enabled: true,
  builder: (context) => MyApp(),
)

Disable Device Preview for Production

Set enabled: false in main.dart before building for production.

🤝 Contributing

We welcome contributions! Here's how you can help:

How to Contribute

Fork the repository
Create a feature branch (git checkout -b feature/AmazingFeature)
Commit your changes (git commit -m 'Add some AmazingFeature')
Push to the branch (git push origin feature/AmazingFeature)
Open a Pull Request

Contribution Guidelines

Follow the existing code style
Write meaningful commit messages
Add tests for new features
Update documentation as needed
Ensure all tests pass before submitting PR

Code of Conduct

Please read our Code of Conduct before contributing.

🧪 Testing

Run Tests

# Run all tests
flutter test

# Run with coverage
flutter test --coverage

# Run specific test
flutter test test/widget_test.dart

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

👥 Contact

Project Maintainer: Your Name

📧 Email: your.email@example.com
🐙 GitHub: @yourusername
💼 LinkedIn: Your Name

Project Link: https://github.com/yourusername/campusquest

🙏 Acknowledgments

Flutter Team - For the amazing framework
Supabase - For the powerful backend platform
Material Design - For design guidelines
All contributors who have helped improve this project

📊 Project Status

🗺 Roadmap

⭐ Star this repository if you find it helpful!

Made with ❤️ by the CampusQuest Team

Name		Name	Last commit message	Last commit date
Latest commit History 13 Commits
android		android
assets		assets
ios		ios
lib		lib
linux		linux
macos		macos
test		test
web		web
windows		windows
.gitignore		.gitignore
.metadata		.metadata
README.md		README.md
SETUP-INSTRUCTIONS.md		SETUP-INSTRUCTIONS.md
analysis_options.yaml		analysis_options.yaml
create-release.ps1		create-release.ps1
devtools_options.yaml		devtools_options.yaml
download-app.ps1		download-app.ps1
pubspec.lock		pubspec.lock
pubspec.yaml		pubspec.yaml

Folders and files

Latest commit

History

Repository files navigation

🎓 CampusQuest

Modern Campus Management System

📋 Table of Contents

🎯 About

Why CampusQuest?

✨ Features

👨‍🎓 For Students

👨‍🏫 For Instructors

👨‍💼 For Administrators

🎨 General Features

🛠 Tech Stack

Frontend

Backend

Key Dependencies

📥 Installation

Prerequisites

Step 1: Clone the Repository

Step 2: Install Dependencies

Step 3: Configure Supabase

Step 4: Run the Application

Step 5: Build for Production

📁 Project Structure

🏗 Architecture

Design Pattern

Module Structure

Data Flow

⚙️ Configuration

Environment Variables

Theme Customization

Firebase (Optional)

🚀 Usage

Running in Development Mode

Running with Device Preview

Disable Device Preview for Production

🤝 Contributing

How to Contribute

Contribution Guidelines

Code of Conduct

🧪 Testing

Run Tests

📝 License

👥 Contact

🙏 Acknowledgments

📊 Project Status

🗺 Roadmap

⭐ Star this repository if you find it helpful!

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages