Skip to main content

Installation Guide

Prerequisites​

Skipping these prerequisites may lead to installation issues.

1. Authenticate with Packistry​

The automatic installer requires that you authenticate with Packistry before proceeding. If you haven't done so yet, please complete that step first.

You can find the relevant guide here: Packistry Authentication Guide

Additionally, ensure that the following dependencies are installed on your system:

  • Docker
  • Docker Compose
  • Yarn
  • Composer
  • PHP

Make sure ports 3306, 8080, and 8000 are not already in use.

2. Login with Docker​

You have to login with Docker before running the installer:

docker login git.qlic.nl

You will need to fill in your Gitea username and a personal access token as the password.

You can create a personal access token here with at least package read permissions.

Cloning the Repository​

Start by opening your terminal and cloning the Skeleton repository:

git clone --depth=1 git@git.qlic.nl:qore/skeleton.git myproject

Run the automatic installer

./install.sh
info

The automatic installer will set up everything for you. It will also open up a terminal and run cd frontend && yarn && yarn dev to start the frontend. The back-end is served by Docker.

The next time you want to start the frontend, you can do this yourself. If you run into any issues, try the manual installation.

Working on Qore source?​

If you want to change Qore itself, see the Qore development guide.