Documentation

Requirements

• PHP >= 8.2
• Composer
• Node.js & NPM
• MySQL/PostgreSQL
• Apache/Nginx

Installation Steps

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

composer install
npm install

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

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=projecttracker
DB_USERNAME=root
DB_PASSWORD=

php artisan migrate --seed

php artisan storage:link

npm run build

php artisan serve

Project Tracker includes a comprehensive settings management system with 60+ configurable settings organized in 9 groups.

Using Settings in Code

Helper Function:

// Get setting value
$appName = setting('app_name');
$email = setting('contact_email', 'default@example.com');

// In Blade templates
Tracker
Built with Laravel & TailwindCSS

Model Methods:

use App\Modules\Setting\Models\Setting;

// Get setting
$value = Setting::get('app_name');

// Set setting
Setting::set('app_name', 'My App', 'string', 'general');

// Get all settings by group
$general = Setting::ofGroup('general')->get();

ViewServiceProvider Variables:

// Available in all Blade views
Tracker
Project & Thesis Tracking System


Built with Laravel & TailwindCSS
© 2025 Project Tracker. All rights reserved.

Settings Groups

Project Tracker supports multiple authentication methods that can be enabled/disabled from Settings → Auth & Security.

Available Auth Methods

Auth Settings Model

use App\Modules\User\Models\AuthSetting;

// Check if email login is enabled
if (AuthSetting::getBool('email_login_enabled', true)) {
    // Show email login form
}

// Get OTP settings
$otpLength = AuthSetting::get('otp_length', '6');
$otpExpiry = AuthSetting::get('otp_expiry_minutes', '5');

// Check social providers
$googleEnabled = AuthSetting::getBool('google_login_enabled');
$facebookEnabled = AuthSetting::getBool('facebook_login_enabled');

Configure advanced developer options for debugging, APIs, webhooks, and feature toggles. Access via: Settings → Developer

Application Settings

// Check debug mode in code
if (setting('app_debug', false)) {
    // Debug mode is enabled
    Log::debug('Debug information');
}

$appUrl = setting('app_url', config('app.url'));

API Configuration

// Use in middleware
use App\Modules\Setting\Models\Setting;

if (setting('enable_api', false)) {
    $rateLimit = setting('api_rate_limit', 60);
    // Apply rate limiting
}

Webhooks

// Send webhook notification
if (setting('enable_webhooks', false)) {
    $webhookUrl = setting('webhook_url');
    
    Http::post($webhookUrl, [
        'event' => 'user.registered',
        'data' => [
            'user_id' => $user->id,
            'email' => $user->email,
            'timestamp' => now()
        ]
    ]);
}

{
  "event": "user.registered",
  "data": {
    "user_id": 123,
    "email": "user@example.com",
    "timestamp": "2025-11-06 10:30:00"
  }
}

Feature Toggles

// Check feature flags in Blade

// Check in Controller
if (setting('enable_chat')) {
    // Show chat interface
}

Best Practices

Project Tracker includes a complete database backup system powered by Spatie Laravel Backup. Automatically backup your database on schedule or manually trigger backups anytime. Access via: Settings → Backup Configuration

Configuration Options

Using Backup Commands

# Run backup now (respects settings)
php artisan backup:run-now

# Run Spatie backup directly (database only)
php artisan backup:run --only-db

# Run full backup (database + files)
php artisan backup:run

# Remove old backups based on retention policy
php artisan backup:clean

# Monitor backup health
php artisan backup:monitor

# List all backup files
php artisan backup:list

Scheduling Automatic Backups

Add backup commands to your app/Console/Kernel.php:

protected function schedule(Schedule $schedule)
{
    // Daily backup at 2 AM
    if (setting('enable_auto_backup', false)) {
        $frequency = setting('backup_frequency', 'daily');
        
        $backup = $schedule->command('backup:run-now');
        
        switch ($frequency) {
            case 'daily':
                $backup->daily()->at('02:00');
                break;
            case 'weekly':
                $backup->weekly()->sundays()->at('02:00');
                break;
            case 'monthly':
                $backup->monthly(1, '02:00');
                break;
        }
    }
    
    // Clean old backups daily at 3 AM
    $schedule->command('backup:clean')->daily()->at('03:00');
}

Using in Code

use Illuminate\Support\Facades\Artisan;

// Check if backups are enabled
if (setting('enable_auto_backup', false)) {
    // Trigger backup
    Artisan::call('backup:run-now');
}

// Get backup settings
$frequency = setting('backup_frequency', 'daily');
$storage = setting('backup_storage', 'local');
$retention = setting('backup_retention_days', 30);

// Check backup files
$disk = Storage::disk('local');
$backups = $disk->allFiles('Laravel');

Cloud Storage Setup

AWS_ACCESS_KEY_ID=your_key
AWS_SECRET_ACCESS_KEY=your_secret
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=your_bucket
AWS_USE_PATH_STYLE_ENDPOINT=false

composer require spatie/flysystem-dropbox

composer require masbug/flysystem-google-drive-ext

Best Practices

Role-based access control using Spatie Laravel Permission package with pre-configured roles and permissions.

Default Roles

Using Permissions in Code

// Check permission
if (auth()->user()->can('edit-users')) {
    // Allow action
}

// In Blade templates

// Assign role
$user->assignRole('admin');

// Check role
if ($user->hasRole('superadmin')) {
    // Admin actions
}

Available Permissions

Project Tracker uses Laravel Modules for a clean, maintainable architecture. Each module is self-contained with its own controllers, models, views, and routes.

Creating a New Module

php artisan make:module BlogModule

Module Structure

app/Modules/YourModule/
├── Http/
│   └── Controllers/
├── Models/
├── resources/
│   ├── views/
│   └── lang/
└── routes/
    ├── web.php
    └── api.php

Existing Modules

Global helper functions available throughout the application.

Available Helpers

$appName = setting('app_name');
$email = setting('contact_email', 'default@example.com');

echo app_name(); // Returns application name from settings

$logoPath = app_logo(); // Returns logo storage path

$faviconPath = app_favicon(); // Returns favicon storage path