Extending the Codebase

JournalPHP is built on standard Laravel mechanisms. You can add new functionality without forking — through Service Providers, Events, Middleware, and custom code.

Service Providers

Providers are registered in config/app.php → providers:

Provider	Purpose
AppServiceProvider	Interface bindings (AI, image moderation)
RepositoryServiceProvider	Data and config repositories
MetaBuilderServiceProvider	SEO meta builders
EventServiceProvider	Events and Socialite provider registration
HorizonServiceProvider	Horizon (email access from admin → Access, /admin-panel/system/access)
RouteServiceProvider	Route file loading

Adding a Service Binding

In AppServiceProvider::register():

$this->app->bind(MyServiceInterface::class, MyService::class);
// or
$this->app->singleton(AnotherService::class);

Adding an OAuth Provider

1. Install a package from SocialiteProviders
2. Register a Listener in EventServiceProvider:

protected $listen = [
    SocialiteWasCalled::class => [
        'SocialiteProviders\\MyProvider\\MyProviderExtendSocialite',
    ],
];

3. Add fields in AuthSettingsController and resources/js/Admin/Pages/Settings/Auth/Edit.vue
4. Store Client ID / Secret in the config table

Supported OAuth providers: Google, Yandex, VKontakte, Facebook, Apple, GitHub. One Tap (Google, Yandex) is configured on the same page.

Repository Pattern

Adding a New Admin Panel Setting

1. Migration — add a record to config:

DB::table('config')->insert([
    'key' => 'my_feature',
    'value' => json_encode(['enabled' => false]),
]);

2. Interface — app/Repositories/Config/Interfaces/GetMyFeatureRepositoryInterface.php

3. Implementation — app/Repositories/Config/GetMyFeatureRepository.php

4. Binding in RepositoryServiceProvider:

$this->app->bind(
    GetMyFeatureRepositoryInterface::class,
    GetMyFeatureRepository::class
);

5. Controller — app/Http/Controllers/Admin/MyFeatureSettingsController.php

6. Vue page — resources/js/Admin/Pages/Settings/MyFeature.vue

7. Route in routes/admin.php

8. Section in config/admin_sections.php (key like settings/my-feature) and menu item in AppSidebar.vue

Actions

New business operations as Action classes:

namespace App\Actions\MyFeature;

class DoSomethingAction
{
    public function execute(DoSomethingDTO $dto): Result
    {
        // business logic
    }
}

Call from a controller:

public function store(MyRequest $request, DoSomethingAction $action)
{
    $result = $action->execute(DoSomethingDTO::fromRequest($request));
    return back();
}

Artisan Commands

New commands go in app/Console/Commands/. They are auto-loaded via $this->load() in Kernel.php.

php artisan make:command MyCommand

Middleware

php artisan make:middleware MyMiddleware

Register in app/Http/Kernel.php (globally or in route groups).

Events & Listeners

php artisan make:event PostPublished
php artisan make:listener NotifySubscribers --event=PostPublished

Register in EventServiceProvider::$listen.

Observers

// AppServiceProvider::boot()
Post::observe(PostObserver::class);

Adding an Admin Panel Section

1. Add a key to config/admin_sections.php:

'settings/my-section' => 'My Section',

2. Add a menu item to resources/js/Admin/Layout/AppSidebar.vue

3. Create a controller and route in routes/admin.php:

Route::get('/admin-panel/my-section', [MySectionController::class, 'index']);

4. Create an Inertia page in resources/js/Admin/Pages/

Swappable Drivers

Example: adding a new AI provider:

1. Implement AiServiceInterface from app/Contracts/
2. Register it in AiServiceProvider with a config condition
3. Add selection fields to AI Settings (/admin-panel/ai-settings); DEEPSEEK_* env vars are used as fallback before admin configuration is saved

Local Packages

Via Composer path repository:

{
    "repositories": [
        {
            "type": "path",
            "url": "./packages/my-package"
        }
    ]
}

Register the package's Service Provider in config/app.php.

Routes

File	Route type
routes/web.php	Public and authenticated
routes/admin.php	Admin-only

Laravel Sanctum is installed, but routes/api.php does not exist.

Forking

The MIT license allows any modifications in a fork. For significant customizations, fork and work in a separate repository. Merge updates from the main repository via git merge upstream/master.