Installation Guide

Last updated: June 22, 2026

This guide covers the complete installation process for QR Igniter, including the Laravel backend, Flutter mobile app, and documentation portal.

Prerequisites

Ensure you have the required software installed before proceeding with the installation.

System Requirements

Backend Requirements

Software Version Purpose
PHP 8.4+ Laravel runtime
Composer 2.x PHP package manager
MySQL 8.x Database server
Node.js 18+ Asset compilation
npm 9+ Node package manager

Mobile App Requirements

Software Version Purpose
Flutter SDK 3.7.2+ Cross-platform framework
Dart 3.x Programming language
Xcode 14+ iOS development (macOS only)
Android Studio 2023+ Android development

Backend Installation

Step 1: Clone the Repository

git clone git@git.kickfire.co.uk:web/teec/ignitedqr.git
cd ignitedqr/backend

Step 2: Install PHP Dependencies

composer install

Step 3: Environment Configuration

# Copy the example environment file
cp .env.example .env

# Generate application key
php artisan key:generate

Step 4: Database Configuration

Edit the .env file with your database credentials:

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=laravel_ignited_qr2
DB_USERNAME=your_username
DB_PASSWORD=your_password

Step 5: Run Migrations

# Create database tables
php artisan migrate

# Seed initial data (optional)
php artisan db:seed

Step 6: Create Admin User

php artisan make:filament-user

Follow the prompts to create your admin account.

Step 7: Start Development Server

php artisan serve

Access the admin panel at http://localhost:8000/admin

Flutter App Installation

Step 1: Navigate to Flutter Directory

cd flutter_app

Step 2: Install Dependencies

flutter pub get

Step 3: Configure API Endpoint

Edit lib/core/constants/app_constants.dart:

class AppConstants {
  static const String apiBaseUrl = 'https://qr2.ignited.cloud';
  static const String baseUrl = 'https://qr2.ignited.cloud/api/v1';
}

Step 4: Run the App

# iOS
flutter run -d ios

# Android
flutter run -d android

Verification

Backend Tests

cd backend
php artisan test

Expected: 680 tests passing (97.2% coverage)

Flutter Tests

cd flutter_app
flutter test

Expected: 33 tests passing

Production Deployment

For production deployment, ensure you configure proper SSL certificates, set APP_ENV=production, and follow security best practices. See the System Architecture guide for more details.

Next Steps