Installation

To install Qore, start by cloning Skeleton. This is a Laravel application that is configured to have Qore installed by default.

git clone git@git.qlic.nl:qore-next/skeleton.git

Then navigate to the project directory and install the backend:

cp .env.example .env
composer install
php artisan key:generate

Install the frontend dependencies:

pnpm install

By default, the database driver is SQLite; create a database file:

touch database/database.sqlite

Publish the Qore migrations, migrate the database and seed the default data:

php artisan vendor:publish --tag=qore-next.system.db # publish the latest Qore migrations
php artisan migrate:fresh --seed

Create the storage symlink:

php artisan storage:link

Development environment

Make sure to enable tools like eslint and prettier in your IDE.

Running The Application

To quickly start a development server and run the frontend:

composer dev

The username is admin@qlic.nl and the password can be found in .env as DEFAULT_USER_PASSWORD.

If pcntl is not enabled on your system, you can run the commands separately:

php artisan serve
pnpm run dev

Testing

Run the application tests:

php artisan test

Websockets

Websockets in Qore are optional. Start Reverb when the app needs realtime node reloads, notifications or toasts:

php artisan reverb:start

Then enable broadcasting in AppServiceProvider:

qore()->setIsBroadcastingEnabled(true)

Make sure your .env has BROADCAST_CONNECTION set to reverb:

BROADCAST_CONNECTION=reverb

REVERB_APP_ID=my-app-id
REVERB_APP_KEY=my-key
REVERB_APP_SECRET=my-secret
REVERB_HOST=127.0.0.1
REVERB_PORT=6001
REVERB_SERVER_PORT="${REVERB_PORT}"
REVERB_SCHEME=http

VITE_REVERB_APP_KEY="${REVERB_APP_KEY}"
VITE_REVERB_HOST="${REVERB_HOST}"
VITE_REVERB_PORT="${REVERB_PORT}"
VITE_REVERB_SCHEME="${REVERB_SCHEME}"