Merge pull request 'fix+improve-project-setup' (#8) from fix+improve-project-setup into master
Reviewed-on: #8 Reviewed-by: Timotheus Pokorra <timotheus.pokorra@hostsharing.net>
This commit is contained in:
commit
e427bb1784
32
README.md
32
README.md
@ -5,7 +5,6 @@ For architecture consider the files in the `doc` and `adr` folder.
|
|||||||
|
|
||||||
<!-- generated TOC begin: -->
|
<!-- generated TOC begin: -->
|
||||||
- [Setting up the Development Environment](#setting-up-the-development-environment)
|
- [Setting up the Development Environment](#setting-up-the-development-environment)
|
||||||
- [SDKMAN](#sdkman)
|
|
||||||
- [PostgreSQL Server](#postgresql-server)
|
- [PostgreSQL Server](#postgresql-server)
|
||||||
- [Markdown](#markdown)
|
- [Markdown](#markdown)
|
||||||
- [Render Markdown embedded PlantUML](#render-markdown-embedded-plantuml)
|
- [Render Markdown embedded PlantUML](#render-markdown-embedded-plantuml)
|
||||||
@ -52,12 +51,10 @@ Everything is tested on _Ubuntu Linux 22.04_ and _MacOS Monterey (12.4)_.
|
|||||||
To be able to build and run the Java Spring Boot application, you need the following tools:
|
To be able to build and run the Java Spring Boot application, you need the following tools:
|
||||||
|
|
||||||
- Docker 20.x (on MacOS you also need *Docker Desktop* or similar) or Podman
|
- Docker 20.x (on MacOS you also need *Docker Desktop* or similar) or Podman
|
||||||
- PostgreSQL Server 15.5-bookworm
|
- optionally: PostgreSQL Server 15.5-bookworm
|
||||||
(see instructions below to install and run in Docker)
|
(see instructions below to install and run in Docker)
|
||||||
- Java JDK at least recent enough to run Gradle
|
- The matching Java JDK at will be automatically installed by Gradle toolchain support.
|
||||||
(JDK 17.x will be automatically installed by Gradle toolchain support)
|
- You also might need an IDE (e.g. *IntelliJ IDEA* or *Eclipse* or *VS Code* with *[STS](https://spring.io/tools)* and a GUI Frontend for *PostgreSQL* like *Postbird*.
|
||||||
|
|
||||||
We recommend to use an IDE (e.g. *IntelliJ IDEA* or *Eclipse* or *VS Code* with *[STS](https://spring.io/tools)* and optionally a GUI Frontend for *PostgreSQL* like *Postbird*.
|
|
||||||
|
|
||||||
If you have at least Docker and the Java JDK installed in appropriate versions and in your `PATH`, then you can start like this:
|
If you have at least Docker and the Java JDK installed in appropriate versions and in your `PATH`, then you can start like this:
|
||||||
|
|
||||||
@ -105,30 +102,9 @@ And to see the full, currently implemented, API, open http://localhost:8080/swag
|
|||||||
If you still need to install some of these tools, find some hints in the next chapters.
|
If you still need to install some of these tools, find some hints in the next chapters.
|
||||||
|
|
||||||
|
|
||||||
### SDKMAN
|
|
||||||
|
|
||||||
*SdkMan* is not necessary, but helpful to install and switch between different versions of SDKs (Software-Development-Kits) and development tools in general, e.g. *JDK* and *Gradle*.
|
|
||||||
It is available for _Linux_ and _MacOS_, _WSL_, _Cygwin_, _Solaris_ and _FreeBSD_.
|
|
||||||
|
|
||||||
You can get it from: https://sdkman.io/.
|
|
||||||
|
|
||||||
<big>**⚠**</big>
|
|
||||||
Yeah, the `curl ... | bash` install method looks quite scary;
|
|
||||||
but in a development environment you're downloading executables all the time,
|
|
||||||
e.g. through `npm`, `Maven` or `Gradle` when downloading dependencies.
|
|
||||||
Thus, maybe you should at least use a separate Linux account for development.
|
|
||||||
|
|
||||||
Once it's installed, you can install *JDK* and *Gradle*:
|
|
||||||
|
|
||||||
sdk install java 17.0.3-tem
|
|
||||||
sdk install gradle
|
|
||||||
|
|
||||||
sdk use java 17.0.3-tem # use this to switch between installed JDK versions
|
|
||||||
|
|
||||||
|
|
||||||
### PostgreSQL Server
|
### PostgreSQL Server
|
||||||
|
|
||||||
You could use any PostgreSQL Server (from version 13 on) installed on your machine.
|
You could use any PostgreSQL Server (version 15) installed on your machine.
|
||||||
You might amend the port and user settings in `src/main/resources/application.yml`, though.
|
You might amend the port and user settings in `src/main/resources/application.yml`, though.
|
||||||
|
|
||||||
But the easiest way to run PostgreSQL is via Docker.
|
But the easiest way to run PostgreSQL is via Docker.
|
||||||
|
@ -207,7 +207,7 @@ project.tasks.spotlessJava.dependsOn(
|
|||||||
// OWASP Dependency Security Test
|
// OWASP Dependency Security Test
|
||||||
dependencyCheck {
|
dependencyCheck {
|
||||||
nvd {
|
nvd {
|
||||||
apiKey = project.property('OWASP_API_KEY') // set it in ~/.gradle/gradle.properties
|
apiKey = project.properties['OWASP_API_KEY'] // set it in ~/.gradle/gradle.properties
|
||||||
delay = 16000
|
delay = 16000
|
||||||
}
|
}
|
||||||
format = 'ALL'
|
format = 'ALL'
|
||||||
|
@ -59,9 +59,6 @@ public class HsOfficeBankAccountController implements HsOfficeBankAccountsApi {
|
|||||||
|
|
||||||
|
|
||||||
final var saved = bankAccountRepo.save(entityToSave);
|
final var saved = bankAccountRepo.save(entityToSave);
|
||||||
// em.persist(entityToSave);
|
|
||||||
// final var saved = entityToSave;
|
|
||||||
// em.flush();
|
|
||||||
|
|
||||||
final var uri =
|
final var uri =
|
||||||
MvcUriComponentsBuilder.fromController(getClass())
|
MvcUriComponentsBuilder.fromController(getClass())
|
||||||
|
Loading…
Reference in New Issue
Block a user