IS216.023

Requirements

For building and running the application you need:

• Node 20 & Npm 10
• JDK 21
• Maven 3

Run the application locally

Install the dependencies:

npm install
npm run prepare

Make sure to connect to your databse by defining the env file env.properties located in /src/main/resources/. For example:

# /src/main/resources/env.properties
DB_DDL_AUTO=update
DB_URL=jdbc:postgresql://localhost:5432/postgres
DB_USERNAME=your_username
DB_PASSWORD=your_password

Run the server:

mvn spring-boot:run

Use a browser to navigate to http://localhost:8080/swagger-ui/index.html.

Run tests

mvn test

Other commands

Format code

mvn fmt:format

How to name a branch?

Branch name pattern:

type/description-in-kebab-case

type/issue-#{issue_number}

Examples:

feature/issue-#99

hotfix/quick-fix-for-an-emergency

Common types according to simplified convention for naming branches

• feature: adding, refactoring or removing a feature
• bugfix: fixing a bug
• hotfix: changing code with a temporary solution and/or without following the usual process (usually because of an emergency)
• test: experimenting outside of an issue/ticket

How to name a commit message?

Commitlint checks if your commit messages meet the conventional commit format.

Commit message pattern:

type(scope?): subject  #scope is optional; multiple scopes are supported (current delimiter options: "/", "\" and ",")

Examples:

chore: run tests on travis ci

fix(server): send cors headers

feat(blog): add comment section

Common types according to commitlint-config-conventional (based on the Angular convention) can be:

• build
• chore
• ci
• docs
• feat
• fix
• perf
• refactor
• revert
• style
• test

References

Read these references if needed:

• Open api swagger
• Lombok
• JPA/Hibernate entity relationships
• Hibernate type mappings