BWCamp (福智綜合資料庫)

BWCamp is a comprehensive camp management system designed to handle the complex logistics of organizing large-scale events. It streamlines volunteer management, student registration, and on-site operations.

Table of Contents

• Key Features
  • Volunteer Management
  • Student Registration
  • System Administration
• Tech Stack
• Getting Started
  • Prerequisites
  • Installation
  • Docker Development
• Usage
  • Common Commands
• License

Key Features

👥 Volunteer Management

• Registration & Recruitment: Streamlined process for volunteer sign-ups.
• Group Management: Organize volunteers into specific job groups.
• Check-in System: On-site and course-specific check-in capabilities.

📝 Student Registration

• Multi-channel Registration: Supports general public registration and special invitation channels.
• Automated Notifications: Confirmation emails and participation tracking.
• Grouping: Automatic and manual grouping of students.

⚙️ System Administration

• Camp Management: Create and configure different types of camps (e.g., Teacher Camp, Youth Camp).
• Permissions: Role-based access control for different staff levels.
• Reporting: Real-time statistics on registration and attendance.

Tech Stack

• Backend: Laravel 9 (PHP 8.0+)
• Frontend: Vue.js 3, Bootstrap 4, Tailwind CSS, jQuery
• Database: MySQL
• Build Tool: Vite

Getting Started

Prerequisites

• PHP >= 8.0
• Composer
• Node.js & NPM
• MySQL

Installation

1. Clone the repository

   git clone https://github.com/LZong-tw/bwcamp.git
   cd bwcamp

2. Install PHP dependencies

   composer install

3. Install JavaScript dependencies

   npm install

4. Environment Setup

   cp .env.example .env
   php artisan key:generate

   Configure your database settings in .env

5. Run Migrations

   php artisan migrate

6. Start Development Server

   npm run dev
   php artisan serve

Docker Development

If you prefer using Docker, you can use the provided docker-compose.yml file.

1. Setup Environment

   cp .env.example .env
   # Configure .env settings (DB_HOST=db, REDIS_HOST=redis, etc.)

2. Start Containers

   docker-compose up -d

3. Install Dependencies & Setup

   docker-compose exec app composer install
   docker-compose exec app npm install
   docker-compose exec app php artisan key:generate
   docker-compose exec app php artisan migrate

4. Access Application The application will be available at http://localhost.

Usage

Common Commands

• Clear Cache:

  php artisan config:cache

• Restart Queue Worker (Required after code changes affecting queues):

  php artisan queue:restart

License

This project is open-sourced software licensed under the MIT license.