• SVQK is an asset for developing web applications using SvelteKit, Quarkus, and Playwright.
• You can start development with both the Frontend and Backend in a state where they pass tests (Unit, Integration, and End-to-End).
• Everything from setup to End-to-End testing is completed with commands, making it executable in a CI/CD environment as well.

GitHub Docs

Quick Start

To develop applications using SVQK, you need the following software.

• Docker Desktop
• JDK v21
• Maven
• Node.js v22
• pnpm
• Git
• Visual Studio Code

To start developing with SVQK, create a project using Maven Archetype, which SVQK provides. To create a project from Archetype, run the following command.

• Windows (cmd)

  1. Set the console character code to UTF-8.

     chcp 65001

  2. Create a SVQK project.

     mvn archetype:generate ^
       -DarchetypeGroupId=dev.aulait.svqk ^
       -DarchetypeArtifactId=svqk-archetype-refimpl ^
       -DarchetypeVersion=CHECK_THE_LATEST_ON_GITHUB ^
       -DgroupId=my.group.id ^
       -DartifactId=my-artifactid ^
       -Dversion=1.0-SNAPSHOT

     Types of archetype

  3. Move to the directory of the created project and execute the setup command.

     cd my-artifactid

     mvnw install -T 1C -P setup

     Setup command processing details

  4. Open the created project as a VSCode workspace.

     code my-artifactid.code-workspace

     Project Structure

  5. Start the Backend and Frontend applications using VSCode Task.

     • Ctrl + Shift + P > Tasks: Run task > start-backend

     • Ctrl + Shift + P > Tasks: Run task > start-frontend

  6. Once the Frontend application is started, the following URL will be displayed in the browser.

     http://localhost:5173

  7. [Optional][Try Generator] Execute Generator in VSCode Task to generate a page and an automated test that performs CRUD operations on the world table.

     • Ctrl + Shift + P > Tasks: Run task > generate

     • Select a component -> all

     • Enter tables -> world

     Access http://localhost:5173/worlds when the Task is finished.

     (See README for more information on Generator.)

• Mac

A single setup command can perform all necessary project builds at once.

When you open a project in VS Code, the DB container is automatically started.

Backend / Frontend servers can be started from VS Code.

End-to-End tests can be executed using Playwright and a test report can be generated.