Spring Boot + Svelte Template

Description

// TODO: Insert Project Description

Installation

Because this project is divided into a Backend and Frontend, both have to be installed seperately.

Back-End

The Backend can be used using Gradle or Maven.

Gradle

cd swa
gradle init

Maven

cd swa
mvn install

Development

For backend development purposes, some Git Hooks were setup.

These Hooks can be registered using the Shell Script in the Project Root:

./install_hooks.sh

Front-End

The Frontend is a Svelte Project and thus depends on Node.js and npm (see NPM Installation Page).

Once Node.js and npm are set up, install the needed packages using npm:

cd static
npm install

Usage

Front-End

Production

The Frontend is served using the Backend.

Because of this the Backend is compiled into /swa/main/resources/ which is automatically served by the Backend when it is running.

The Frontend can be compiled using:

cd static
npm run build

This will compile the source files in the static-Folder and automatically place them in /swa/main/resources/.

Development

The Frontend can be started without the Backend using the Vite Development Server:

cd static
npm run dev

This will run the Development Server (on localhost:5173) which will automatically recompile any changes to the source Files and display them in the browser.

Keep in mind: The Backend will not run and thus any API-Calls will not be able to be completed.

Back-End

Gradle

cd swa
gradle bootRun

Maven

cd swa
mvn spring-boot:run

Contributing

Only members of the group can contribute to this project.