The application is created to meet the basic functional requirements of everyone interested in managing football teams, as well as balancing them (via the sorting algorithm). The idea was born thanks to my many years of experience in taking part in amateur football games on all kinds of pitches (usually on the so-called Orlik football fields). The main problem I faced over the years was the lack of a centralized, dedicated platform for managing people in terms of creating two football teams, setting the date and location of the next match and balancing the squads so that the gaming experience was as pleasant as possible for each of us. Usually, the contact and information channels for those interested in the game were facebook, whats-app, etc., which often caused unnecessary confusion in the flow of information. It also carried the responsibility for appointing the teams that would competed against each other on the field on the organizers of the games, which was usually maximized the human factor in terms of balancing these teams. My application tries to meet the above problems so that each game is set in one transparent place and so that an algorithm that avoids simple human errors is responsible for creating competing teams.
The application is prepared on two levels: back-end written in java and front-end written in ReactJS. It is strongly recommended to use all the microservices included in the whole, so that the application works in accordance with its basic assumptions. Below is a list of links to the required microservices:
-
https://github.com/DudekJakub/Football-Balancer_1.0_GATEWAY-SERVICE : Spring Gateway Microservice responsible for single point entrance to the application (along with load-balancer in case of running more then one instance of given microservice).
-
https://github.com/DudekJakub/Football-Balancer_1.0_AUTH-SERVICE : Authentication Microservice responsible for verification "who the user is" (creating user account & log-in into the system).
-
https://github.com/DudekJakub/Football-Balancer_1.0_EUREKA-SERVICE : Eureka Discovery Microservice responsible for registration each microservice and making them visible for Gateway routing system.
-
https://github.com/DudekJakub/Football-Balancer_1.0_NOTIFICATION-CHAT-SERVICE : Notification/Chat Microservice responsible for managing real-time notifications along with chat feature (which is still under the development)
When all of the above microservives are built and ready to run, first pleace run below command to pre-mature preparing required elements such as MySQL database, Mongo database and RabbitMQ queue system:
using docker-compose:
docker-compose -f docker-compose.yaml up -d
And to stop:
docker-compose down
Then run all microservices along with monlith and you are ready to go!
To test application I recommend using Swagger UI available (after fulfilling all above steps) under following link:
To use front-end layer instead of Swagger UI/Postman please download front-end repository available under following link:
Front-end can be start via following command:
npm run dev
| DESCRIPTION | STATUS |
|---|---|
| Creating user account | ready |
| Logging into the application | ready |
| Browsing the list of rooms | ready |
| Searching for specific room/user via search bar | ready |
| Creating room | ready |
| Joining the room via password | ready |
| Sending request to become a member of the room | ready |
| Setting room's next match date | ready |
| Setting room's next match localization along with google-maps pin | ready |
| Accepting/Rejecting new member request as room's adminstrator | ready |
| Editing room's next match date as room's administrator | ready |
| Accepting/Rejecting new member request as room's adminstrator | ready |
| Editing room's description as room's administrator | ready |
| Editing room's localization as room's administrator | ready |
| Editing room's access visibility as room's administrator - private/public room | ready |
| Creating player along with linking him/her to specific room's member | ready |
| Creating skill for room (along with assigning it to all room's players) | work-in-progress |
| Creating formations in which two teams will face each other and based on which balancing algorithm will work on | work-in-progress |
| Balancing feature | work-in-progress |
| Joining to the queue to next match meeting | work-in-progress |
| TECHNOLOGY | STATUS |
|---|---|
| Swagger UI | implemented |
| MySQL Workbench | implemented |
| GitHub | implemented |
| TECHNOLOGY | STATUS |
|---|---|
| Java 11v. | implemented |
| Gradle (build-tool) | implemented |
| MySQL | implemented |
| MongoDB | implemented |
| MongoDB reactive | implemented |
| RabbitMQ | implemented |
| Webflux (reactive-programming) | implemented |
| Websockets | implemented |
| Spring Boot | implemented |
| Spring Security | implemented |
| Spring Data | implemented |
| Spring Validation | implemented |
| Microservices | implemented |
| AOP (aspect-oriented-programming) | implemented |
| JWToken | implemented |
| Hibernate | implemented |
| Docker | implemented |
| Eureka-discovery-system | implemented |
| Slf4J (logging) | implemented |
| Google-Maps | implemented |
| Lombok | implemented |
| Junit5 | in-progress |
| AssertJ | in-progress |
| Liquibase | in-progress |
| Redis (caching) | in-progress |
| TECHNOLOGY | STATUS |
|---|---|
| ReactJS 15v. | implemented |
| Immer | implemented |
| Axios | implemented |
| Stomp | implemented |
| JWT | implemented |
| Moment | implemented |
| SockJS | implemented |
List includes main technologies. For readability there are no sub-libraries listed.
As project is still under the development process I would like at first to finish all basic functional requirements and then finally provide code for squads balancing alghoritm. After that I will focus on progressing with testing phases for the application:
| TEST PHASE | ORDER |
|---|---|
| Granular Unit Tests | ↓ |
| Integration Tests | ↓ |
| Security Tests | ↓ |
| Functional Tests | ↓ |
| Performance Tests | ↓ |
| Acceptance Tests | - |
Project is fully written by me - Jakub Dudek© 2023 - and it has no restricted licence. Project is open-source.