https://github.com/foobarsgamessmithy/chess-manager
A small spring boot application which can manage chess games for demonstration purposes.
https://github.com/foobarsgamessmithy/chess-manager
bruno-collection docker-compose gradle keycloak liquibase spring-boot
Last synced: 3 months ago
JSON representation
A small spring boot application which can manage chess games for demonstration purposes.
- Host: GitHub
- URL: https://github.com/foobarsgamessmithy/chess-manager
- Owner: foobarsgamessmithy
- Created: 2025-01-19T16:22:39.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2025-02-27T13:28:30.000Z (over 1 year ago)
- Last Synced: 2025-02-27T14:23:22.769Z (over 1 year ago)
- Topics: bruno-collection, docker-compose, gradle, keycloak, liquibase, spring-boot
- Language: Java
- Homepage:
- Size: 157 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# A chess manager
A small spring boot application which can manage chess games for demonstration purposes.
## Usage
A collection of request to interact with the application is in the [docs](./doc/bruno/chess%20manager). Use [Bruno](https://www.usebruno.com/downloads) client to send requests. When application runs with authentication, use the auth request first. All other request will use the auth token form the auth request.
### Authentication request
When the application is started with authentication enabled, you first have to authenticate at the keycloak server. Therefore, you obtain a jwt token which is used in all other requests. The configuration of this request can be found withing the [bruno file](./doc/bruno/chess%20manager/keycloak/Auth.bru). Change username and password to use other test users. Client id and client secret are defined in the [realm](./infrastucture/keycloak/realm-export.json).
## Development
### Available Profiles
- test: Profile is used for unit test execution
- dev: Enable authentication but also h2 console is available
- insecure: Disables authentication
### Keycloak
To use keycloak you can use the [local](https://www.keycloak.org/downloads) installation or the docker image which is configured in the [docker-compose](./infrastucture/docker/docker-compose.yml) file.
The realm configuration must be imported via [realm.json](./infrastucture/keycloak/realm-export.json). Test users are also included in the end of the file. Also, the client secrets are set in the file. Of course this secrets should not be used for production.
The connection from keycloak to the chessmanager app is done with oauth2 like in is this [example](https://www.baeldung.com/spring-boot-keycloak).
#### Roles
Roles are not used in application now.
| role | description |
|---------|-------------|
| user | |
| manager | |
#### Test user
This test user are predefined.
| User name | password | role |
|-----------|----------|---------|
| foobar | foobar | manager |
| drdrunkenstein | drdrunkenstein | user |
### DB Access
When application is running with dev profile the database is accessible via [browser](http://localhost:8081/h2). Credentials can be taken from `spring.datasource` in the [application.properties](./src/main/resources/application.properties)
### Logging
For logging [slf4j](https://www.slf4j.org/manual.html) ist used. The logger can be declared as a static import by the logger factory like this:
`
private static final Logger LOG = LoggerFactory.getLogger(Foo.class);
`
To log information there are different methods for every log level. It is possible to use placeholder to write the content of objects into the log.
`
LOG.debug("Logging the output of my variable: {}.", variable);
`
For the output medium a [logback.xml](./src/main/resources/log/logback.xml) is configured. There is an appender for console when the app is started in development mode and there is an appender for logging into a file in production mode.
The path to the logback.xml is set in the application.properties like this:
`
logging.config=classpath:/log/logback.xml
`
Also, a [banner.txt](./src/main/resources/log/banner.txt) is configured in the application.properties like this:
`
spring.banner.location=classpath:/log/banner.txt
`