README

A Laravel package for submitting tasks to the SHIFT Dashboard from within your application. Provides a clean Vue-based UI component and simple API endpoints to send issue reports or feature requests directly to your SHIFT project.

🚀 Installation

composer require wyxos/shift-php
php artisan install:shift

This will:

Prompt for your SHIFT API token and project token
Save them to your .env
Publish frontend and config files

⚙️ Configuration

Add your SHIFT credentials to .env:

SHIFT_TOKEN=your-api-token
SHIFT_PROJECT=your-project-token
SHIFT_URL=https://shift.wyxos.com

Optional: Publish config to customize routes/middleware.

php artisan vendor:publish --tag=shift

config/shift.php example:

return [
    'token' => env('SHIFT_TOKEN'),
    'project' => env('SHIFT_PROJECT'),
    'url' => env('SHIFT_URL', 'https://shift.wyxos.com'),
    'routes' => [
        'prefix' => 'shift',
        'middleware' => ['web', 'auth']
    ]
];

🧩 Usage

UI Dashboard

After installing, a Vue-based task submission UI is available at:

/shift

This route is protected by the default web and auth middleware (can be customized).

API Endpoints

All endpoints are prefixed (by default with /shift/api) and require authentication:

GET /shift/api/tasks – List tasks
POST /shift/api/tasks – Create a new task
GET /shift/api/tasks/{id} – View a task
PUT /shift/api/tasks/{id} – Update a task

You can interact with them using Laravel’s Http facade:

$response = Http::post('/shift/api/tasks', [
    'title' => 'Bug in report form',
    'description' => 'Submit button doesn’t work on mobile.',
]);

When tasks are submitted, the package automatically includes:

Authenticated user's name, email, and ID
Current environment and application URL

🧪 Testing

Run a test submission with:

php artisan shift:test

This creates a dummy task to verify setup.

🔧 Artisan Commands

install:shift – Interactive installation
shift:test – Submit a test task
shift:publish – Manually publish package assets

wyxos / shift-php

Maintainers

Details