Kompass is still in early stages of development


Additionally Kompass requires you to use

  • PHP 8.1 or newer
  • Laravel 10.0 or newer
  • Laravel Fortify 1.18 or newer
  • Livewire 3.1 or newer
  • Tailwindcss 3.3 or newer

Creating new Laravel application

Before creating your first Laravel project, you should ensure that your local machine has PHP and Composer (opens in a new tab) installed.

If you are developing on macOS, PHP and Composer can be installed within minutes via Laravel Herd (opens in a new tab).

After you have installed PHP and Composer, you may create a new Laravel project via the Composer create-project command:

composer create-project laravel/laravel kompass

Or, you may create new Laravel projects by globally installing the Laravel installer via Composer:

composer global require laravel/installer
laravel new kompass

Create a database

During the installation we need to use a MySQL database. You will need to create a new database and save the credentials for the next step.

Copy the .env.example file

We need to specify our Environment variables for our application. You will see a file named .env.example, you will need to duplicate that file and rename it to .env.

Then, open up the .env file and update your DB_DATABASE, DB_USERNAME, and DB_PASSWORD in the appropriate fields. You will also want to update the APP_URL to the URL of your application.

Next make sure to create a new database and add your database credentials to your .env file, you will also want to add your application URL in the APP_URL variable:


Install Kompass

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

composer require secondnetwork/kompass

With the command we install frontend asset, created new admin user and drop all tables from the database. For a new installation of Kompass!

php artisan kompass:install