mirror of
https://github.com/AJMicke/KickerELO.git
synced 2026-03-11 13:31:02 +01:00
6ba5b7d59e
* Update readme
* First try in oidc implementation
* Add secrets
* Add connection to fs auth provider, redirect not tested
* Working prototype
This commit implements the oidc compatibility with the caveat of having
every subsite under the app path. For that, there is also a redirection
handler to redirect the home page to the app home page.
* Small cleanup
* Fix access even when logged in
* Update application-prod.properties
* Ignore login when in test env
* Fix reviews
* Feature/sign in (#1)
* Add OIDC support (#39)
* Update readme
* First try in oidc implementation
* Add secrets
* Add connection to fs auth provider, redirect not tested
* Working prototype
This commit implements the oidc compatibility with the caveat of having
every subsite under the app path. For that, there is also a redirection
handler to redirect the home page to the app home page.
* Small cleanup
* Fix access even when logged in
* Update application-prod.properties
* Ignore login when in test env
* Fix reviews
* Revert "Add OIDC support (#39)" (#60)
This reverts commit 244f6cbf95.
* Refine the sign in solution by Moritz921
* Fix botched rebase
---------
Co-authored-by: AJMicke <7047945+AJMicke@users.noreply.github.com>
Co-authored-by: Anton Micke <anton.micke@gmail.com>
* Fix bugs
---------
Co-authored-by: AJMicke <7047945+AJMicke@users.noreply.github.com>
Co-authored-by: Anton Micke <anton.micke@gmail.com>
76 lines
2.0 KiB
Markdown
76 lines
2.0 KiB
Markdown
# KickerELO
|
|
|
|
KickerELO is a web application for displaying Elo ratings for foosball (table soccer) games.
|
|
It uses **Spring Boot** for the backend, **Vaadin** for the frontend, and **MariaDB** as the database. It is compatible with any OpenID Connect (OIDC) provider.
|
|
|
|
## Requirements
|
|
|
|
- **Java 23** or later
|
|
- **Maven** (if not integrated)
|
|
- **MariaDB** (for production use)
|
|
|
|
## Installation
|
|
|
|
### Clone the repository
|
|
```sh
|
|
git clone https://github.com/your-repo/kickerelo.git
|
|
cd kickerelo
|
|
```
|
|
|
|
If you want to run the application in production mode, you can skip to [Production](#production) and set up the database.
|
|
|
|
|
|
### Testing
|
|
|
|
To run the application in a test environment, you can use an embedded H2 database. This is useful for development and testing purposes.
|
|
|
|
To build the project and run the application with the embedded H2 database, use the following commands:
|
|
|
|
```sh
|
|
mvn clean package
|
|
mvn spring-boot:run -Ptest
|
|
```
|
|
|
|
|
|
### Production
|
|
|
|
The application requires a database to store the data. If MariaDB is already installed, make sure the database and
|
|
credentials are correctly configured in `application-prod.properties` and skip to step [Build the project](#build-the-project).
|
|
|
|
#### Set up database
|
|
|
|
You can quickly start a database using Docker and update its schema using the provided `update-schema.sql` file.
|
|
|
|
```sh
|
|
docker run --name kickerelo-db -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=kickerelo -p 3306:3306 -d mariadb:latest
|
|
docker exec -i kickerelo-db mysql -u root -p kickerelo < update-schema.sql
|
|
```
|
|
|
|
|
|
#### Build the project
|
|
|
|
To generate the file `target/kickerelo.jar`:
|
|
|
|
```sh
|
|
mvn clean package -Pproduction
|
|
```
|
|
|
|
### Run the application
|
|
|
|
You can run the application in two ways:
|
|
|
|
1. Using Maven:
|
|
|
|
```sh
|
|
mvn spring-boot:run -Dspring-boot.run.profiles=prod
|
|
```
|
|
|
|
2. Using the built .jar file:
|
|
|
|
```sh
|
|
java -jar target/kickerelo.jar --spring.profiles.active=prod
|
|
```
|
|
|
|
## License
|
|
This project is licensed under the terms of the Do What The F*ck You Want To Public License. See [LICENSE](LICENSE) for more details.
|