Chess WebApp

• Typescript Web Client
• Java Backend

Development - Typescript Web Client

Typescript Client code location ./client

Installation

Install yarn

cd ./client && yarn

Run Web Client

cd ./client && yarn start

Development - Java Backend

Java API code location: ./app

Installation

Install Gradle

Run Application

gradle bootRun --args="--spring.profiles.active=development"

API Documentation

Interact with the REST API (java app must be running)

Swagger WEB UI

Authenticate by runnng the client app, logging in, and getting a token. Copy the token from the client app and paste into the Swagger UI in the top right corner.

Access Database

Interact with the database (java app must be running)

H2 Console

Database is stored as ./app/database/developmentDb.mv.db

Tests

run tests

gradle test

Output is minimal if tests succeed. Verbose if they don't. A pretty HTML test report is generated at ./build/reports/index.html. Open in your browser after running test suite.

Test framework is JUnit 5 (Jupiter)

Add test files in ./app/src/test/java/chess/<path_to_class>/<Class>Test.java; mirror directory structure of ./app/src/main/java/chess/<path_to_class><Class>.java