mirrors/swt23w23
1
0
Fork 0
mirror of https://github.com/st-tu-dresden-praktikum/swt23w23 synced 2024-07-19 21:04:36 +02:00
Code Issues Packages Projects Releases Wiki Activity
The original repository needs to be a private repository. Sadly, Issues and Pull Requests can’t be mirrored. https://catering.salespointframework.org
179 commits 56 branches 0 tags 16 MiB
Java 78%
HTML 17.3%
TeX 3.5%
Makefile 0.6%
Nix 0.4%
Other 0.2%
Find a file
Mathis Kral dfd892d04b
Remove swearing
2023-11-21 18:00:24 +01:00
.github/workflows Add action for checks 2023-11-14 19:22:28 +01:00
.mvn/wrapper Initial commit 2023-10-05 11:42:24 +02:00
src Remove swearing 2023-11-21 18:00:24 +01:00
.editorconfig Enable trimming of trailing whitespace in editorconfig 2023-11-15 15:36:19 +01:00
.envrc Watch shell.nix in envrc 2023-11-16 12:30:08 +01:00
.gitattributes Add interim presentation draft 2023-11-16 19:55:06 +01:00
.gitignore Add interim presentation draft 2023-11-16 19:55:06 +01:00
.gitlint Do not enforce minimum body length in gitlint 2023-11-16 10:18:35 +01:00
.pre-commit-config.yaml Add pre-commit hooks 2023-11-14 19:22:27 +01:00
AUTHORS.txt Add pre-commit hooks 2023-11-14 19:22:27 +01:00
flake.lock Add nix shell 2023-11-11 14:26:18 +00:00
flake.nix Add nix shell 2023-11-11 14:26:18 +00:00
mvnw Initial commit 2023-10-05 11:42:24 +02:00
mvnw.cmd Initial commit 2023-10-05 11:42:24 +02:00
pom.xml Initial commit 2023-10-05 11:42:24 +02:00
readme.adoc Initial commit 2023-10-05 11:42:24 +02:00
shell.nix Add interim presentation draft 2023-11-16 19:55:06 +01:00

readme.adoc 

image:https://github.com/st-tu-dresden-praktikum/swt23w23/workflows/CI%20build/badge.svg["CI Build", link="https://github.com/st-tu-dresden-praktikum/swt23w23/actions"]
image:https://img.shields.io/badge/SonarQube-checked-blue?logo=sonarqube["SonarQube status", link="https://st-lab-ci.inf.tu-dresden.de/sonarqube/"]

// Hi there! We've already included some generally useful information in here.
// Feel free to edit the first section to add a short description of your task and your project.

= Kickstart

The kickstart module is a template project to bootstrap the Java project in the Software Engineering lab.
Each group's repository is initialized with this template.
It contains the following features:

* a skeleton Java 17 web application based on Spring Boot and Salespoint framework (see `src/main/java` and `src/test/java`)
* Asciidoc documentation templates in `src/main/asciidoc`

== Important documents in this repo

* link:src/main/asciidoc/protocols[Meeting Protocols]
* link:src/main/asciidoc/time_recording.adoc[Time recording (Zeiterfassung)]
* link:src/main/asciidoc/pflichtenheft.adoc[Requirements specification (Pflichtenheft)]
* link:src/main/asciidoc/developer_documentation.adoc[Developer documentation (Entwicklerdokumentation)]

== The repository layout

The repository follows the standard Maven project layout. Nearly all artifacts are stored in a subdirectory of `src/`:

  src/
  ├── main/
  │   ├── asciidoc/   -- Documentation of the development process and application (Asciidoc format)
  │   ├── java/       -- Main source code of the application, separated into packages
  │   └── resources/  -- Static assets (images, stylesheets), Thymeleaf templates, etc.
  └── test/
      └── java/       -- Source code of JUnit tests is stored separately

**Pro tip:** In GitHub, press *t* and a "fuzzy file finder" will appear, making it easy to navigate to a file.

== How to run the application?

* In the IDE: find `Application.java`, right-click project, select "Run As > Java Application"
* From the command line: run `./mvnw spring-boot:run`

== How to package the application?

* Run `./mvnw clean package`. The packaged application (a JAR in `target/`) can be run with `java -jar $jarName`.