Karcioszki - The Game

Simple project to improve a knowledge about Java and Angular framework.

Game is very simple, two teams has to compete between each other. When the first team find all the cards that belongs to them they won. There are two team leaders that can see the map. They have a very difficult mission - say just one word that is related to words included on this team cards. When a team has selected another card the move is passing to opposite team.

This game is still in develop.

Running the application

Backend is developed as Spring Boot application that requires Java 11.
Frontend is developed in Angular v11
This application use H2 database to store user data.
User images are stored under C:/karcioszki/uploads/ directory

backend:

Version 2.0.0 under development
gradle bootRun - To run the application Server
gradle bootRun -Pdb=true - To run Server without building Angular Project

Note
Using flag -Pdb=true you always can skip the Angular building process

frontend:

NOTE: Backend server must be running for developing this application
npm run-script start - To start the develop server for Angular in default mode
npm run-script start:pl - To start the develop server for Angular with Polish localization

tests:

gradle test -Pdb=true - To run Java Tests (skip Angular)

run:

When the application server has been started, open browser and type in address field: http://localhost:8080/en-US or http://localhost:8080/pl
to open the application in production mode with a specific locale.

To open this app in Angular development mode just open http://localhost:4200/.

Testing the application

Frontend application has E2E tests build on Cypress Framework. Test files are located under the cypress/integration directory.

npm run-script test_e2e - Type to run Karcioszki tests.
npm run-script cypress - Type to open the Cypress framework to manage the tests.

Documentation

REST API Endpoints are documented in OpenApi Standard v3. The file is inside "docs/api" directory. This file can be imported into Postman application to check the backend endpoints. Using SwaggerEditor you can copy/paste that file and browse endpoint documentation to check required parameters or to find expected output from API.

Developed by:

• @radek2s
• @mdebowska

Legal notice

This application use some of the stock photos from unsplash.com page. We want say thaks to all authors:
JESHOOTS.COM, Frank McKenna, Andrik Langfield, Juliane Liebermann, Vidar Nordli-Mathisen, Tianyi Ma, Luca Bravo, Kalen Emsley, Sabri Tuzcu, Conor Luddy, Bruno Wolff,