Skip to content

svbergmann/TournamentWebApplication

Repository files navigation

Contributors Forks Stargazers Issues MIT License

Logo

TournamentWebApplication

Web Application for displaying a tournament schedule online with a sqlite database in the backend.


Table of Contents

  1. About the Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact

1. About The Project

Web Application for displaying a tournament schedule online with a sqlite database in the backend. It can be used for any kinds of sports and as for right now there are still too few database models. Basically this is just for planning a tournament and let the participants view their game schedule online.

(back to top)

Built With

Spring

Vaadin

Gradle

Java

Checkstyle

Jib

Google-Icons

(back to top)


2. Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

  1. Download and install Intellij Idea
  2. Clone the project with git clone https://github.com/ProfSchmergmann/TournamentWebApplication.git
  3. Let Intellij do its magic e.g.
    • Indexing module
    • Installing gradle
    • Indexing gradle
    • Downloading packages
  4. Download and link Java 17
  5. You are now set to contribute, commit, have fun with this project.

Installation

There is no real installation because this is a Spring-Boot and Vaadin Web-Application but you can run the application using the task bootRun from gradle if you are NOT in production mode (you can see this setting inside the vaadin tag inside the build.gradle file). Otherwise, you have to run vaadinBuildFrontend first before you can execute the bootRun task.

Deployment

If you want to deploy the jar you just need to execute the task bootJar.

TODO: Deploying inside a docker container.

(back to top)


3. Usage

gyms_screenshot_logged_out This is a screenshot of the page showing the tournament gyms with some example values. As you can see there is a menu on the left-hand side where you can also choose other values to be displayed inside the middle of this page.

gyms_screenshot_logged_out_de This screenshot is nearly the same one as the above one with the difference that the user chose german as language. You can see that there is also a support for choosing between english and german as display language.

gyms_screenshot_logged_in Again this screenshot is nearly the same as the two above except from the logged in status of the current user. As you can see by the button in the upper right corner the current user is logged in as an admin or superuser (roles not implemented yet) with the privilege that he can now see the "Add" button and is also able to delete values.

(back to top)


4. Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)


5. License

Distributed under the MIT License. See LICENSE for more information.

(back to top)


6. Contact

Sven Bergmann - sven.bergmann@rwth-aachen.de

Project Link: https://github.com/ProfSchmergmann/TournamentWebApplication/

(back to top)

Releases

No releases published

Packages

No packages published