README

A comprehensive Laravel package that provides back-end support for building a CMS with any front-end framework. This package offers a complete set of features for content management, user management, authentication, and more.

Features

Content Management: Content types, taxonomies, and media management
Admin Interface: Admin pages, dashboard widgets, and settings management
User Management: User roles, permissions, and profiles
Authentication: Two-factor authentication with Laravel Sanctum integration
Notifications: Comprehensive notification system
Themes & Plugins: Support for themes and plugins
PWA Support: Progressive Web App features
Audit Logging: Track changes and user actions

Requirements

PHP 8.2 or higher
Laravel 12.0 or higher
Laravel Sanctum 4.1 or higher

Quick Installation

You can install the CMS Framework package by running the following composer command:

composer require artisanpack-ui/cms-framework

After installation, publish the configuration file:

php artisan vendor:publish --tag=cms-config

Run the migrations to set up the database tables:

php artisan migrate

Documentation

📚 Complete Documentation

Installation Guide - Detailed installation and setup instructions
Configuration - Configuration options and environment setup
Usage Guide - Comprehensive usage examples and tutorials
API Documentation - Complete REST API reference
Migration Guide - Migrating from other CMS frameworks
Testing - Testing strategies and examples
Performance & Troubleshooting - Optimization and common issues
Contributing - Development and contribution guidelines

Quick Start

Content Types

use ArtisanPackUI\CMSFramework\Features\ContentTypes\ContentTypeManager;

app(ContentTypeManager::class)->register('product', [
    'name' => 'Product',
    'plural' => 'Products',
    'description' => 'Products for the store',
    'supports' => ['title', 'editor', 'thumbnail'],
]);

Admin Pages

use ArtisanPackUI\CMSFramework\Features\AdminPages\AdminPagesManager;

app(AdminPagesManager::class)->addPage([
    'title' => 'Custom Settings',
    'slug' => 'custom-settings',
    'callback' => function() {
        return view('custom.settings');
    }
]);

Settings

use ArtisanPackUI\CMSFramework\Features\Settings\SettingsManager;

// Register a setting
app(SettingsManager::class)->register('site_name', 'My Awesome Site');

// Get a setting
$siteName = app(SettingsManager::class)->get('site_name');

Customization with Eventy

The CMS Framework uses the Eventy system for hooks and filters, allowing for extensive customization:

use TorMorten\Eventy\Facades\Eventy;

// Add a filter
Eventy::addFilter('ap.cms.migrations.directories', function($directories) {
    $directories[] = __DIR__ . '/database/migrations';
    return $directories;
});

// Add an action
Eventy::addAction('ap.cms.after_content_save', function($content) {
    // Do something after content is saved
});

Contributing

We welcome contributions! Please see Contributing Guide for details on:

Development setup
Code style guidelines
Testing requirements
Submission process

Security

If you discover a security vulnerability, please send an email to security@artisanpack.com. All security vulnerabilities will be promptly addressed.

artisanpack-ui / cms-framework

Maintainers

Details