Skip to content

CampusQuest is a cross-platform Flutter application designed for managing academic resources, notes, events, and user roles (students, instructors, admins) in a campus environment.

Notifications You must be signed in to change notification settings

Krut369/campusquest

Repository files navigation

campusquest

CampusQuest is a cross-platform Flutter application designed for managing academic resources, notes, events, and user roles (students, instructors, admins) in a campus environment.

Features

  • User authentication and role-based access (Student, Instructor, Admin)
  • Course and program management
  • Notes and file uploads/downloads (with Supabase storage integration)
  • Event scheduling and management
  • Timetable and attendance tracking
  • Assignment creation and submission
  • Cross-platform support: Android, iOS, Windows, Linux, macOS, Web

Project Structure

campusquest/
├── android/           # Android native code & build files
├── assets/            # App assets (images, etc.)
├── build/             # Build outputs (auto-generated)
├── campusquest/       # (May contain additional project files)
├── ios/               # iOS native code & build files
├── lib/               # Dart source code
│   ├── Data/          # Static data (e.g., notes_data.dart)
│   └── modules/       # App modules (admin, student, etc.)
├── linux/             # Linux desktop support
├── macos/             # macOS desktop support
├── test/              # Unit and widget tests
├── web/               # Web support
├── windows/           # Windows desktop support
├── pubspec.yaml       # Flutter/Dart dependencies and metadata
├── README.md          # Project documentation
└── ...                # Other config and metadata files

Getting Started

Prerequisites

  • Flutter SDK
  • Dart SDK (comes with Flutter)
  • Android Studio/Xcode/Visual Studio (for platform-specific builds)
  • Supabase account (for storage backend)

Installation

  1. Clone the repository:

    git clone https://github.com/Krut369/campusquest.git
    cd campusquest
  2. Install dependencies:

    flutter pub get
  3. Configure Supabase:

    • Update your Supabase credentials in the appropriate Dart files (usually in a config or service file).
  4. Run the app:

    • For mobile:
      flutter run
    • For desktop (Windows/Linux/macOS):
      flutter run -d windows   # or linux, macos
    • For web:
      flutter run -d chrome

Building for Release

  • Android:
    flutter build apk or flutter build appbundle
  • iOS:
    flutter build ios
  • Windows/Linux/macOS:
    flutter build windows (or linux, macos)
  • Web:
    flutter build web

Testing

Run all tests with:

flutter test

Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/YourFeature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin feature/YourFeature)
  5. Create a new Pull Request

License

This project is licensed under the MIT License.

Demo Videos

Student Demo

student.mp4

Instructor

instructor.mp4

Admin Demo

admin.mp4

For more information, see the Flutter documentation.

About

CampusQuest is a cross-platform Flutter application designed for managing academic resources, notes, events, and user roles (students, instructors, admins) in a campus environment.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published