README

The development of Kompass

Warning

Kompass is still in development

Kompass is a modern content management system (CMS) built on the Laravel framework, utilizing the TALL stack (Tailwind CSS, Alpine.js, Laravel, and Livewire). This powerful combination allows for a seamless and dynamic user experience, making content management easier and more efficient.

Development Roadmap status

Requirements

Additionally Kompass requires you to use

PHP 8.2 or newer
Laravel 11.30 or newer
Livewire 3.6 or newer
Tailwindcss 4.0 or newer

Installation

Kompass is super easy to install. After creating your new Laravel application you can include Kompass.

composer require secondnetwork/kompass dev-main

With the command we install frontend asset, created new admin user and drop all tables from the database.

php artisan kompass:install

Publishing Kompass's frontend assets in future updates

php artisan vendor:publish --tag=kompass.assets --force && php artisan optimize:clear

To keep assets up-to-date and avoid issues in future updates, we strongly recommend that you add the following command to your composer.json file:

{
    "scripts": {
        "post-update-cmd": [
            // Other scripts
            "@php artisan vendor:publish --tag=kompass.assets --force"
        ]
    }
}

Documentation

Documentation is available at https://kompass.secondnetwork.de

Screenshots

Postcardware

We highly appreciate you sending us a postcard from your hometown.

That we know you're using great package(s) from us.

Our address is: B&B. Markenagentur / Digital Unit | Georgstraße 56 30159 Hannover Germany

Security

If you discover any security related issues, please email github@secondnetwork.de instead of using the issue tracker.

Credits

License

The Kompass CMS is open-sourced software licensed under the MIT.

secondnetwork / kompass

Maintainers

Details