InternetEnemies / CombatCritters

CombatCritters API repository
0 stars 0 forks source link

Combat Critters 2.0

Link to Repositories

Frontends

The desktop application is a management/admin interface for the game which is played on the React web interface.

Wrappers

These wrappers provide an interface for the frontends to interact with the api, they will be delivered via the languages respective package managers (NPM and NuGet).

Test Reports

Available in this repo

Setup

Prerequisites

Starting: docker compose -p combatcritters up -d postgres

Stopping: docker compose -p combatcritters down

Start api

./gradlew critterSpring:bootRun

The api will be online on port 8080, refer to the API documentation below for details.

Test

./gradlew <test suite>

Test Suites:

Starting backend for production / frontend

docker compose up

This will start the backend on port 4000

API

Summary and Vision

Our vision and project summary can be found here

Architecture

Our architecture can be found here

Sequence Diagrams

Can be found here

Testing plan

Can be found here

Work Division

We will try to separate dev tasks equally in correspondence to everyone's schedule and ability. However, if one of us is busy with something else, the rest of us will try our best to cover his task. We will divide our tasks on the Github project task board, making sure everyone has only one task at a time. We will at minimum host one in-person meeting every week on Wednesday to make sure everyone is on the same page. We will communicate using discord in case there are any issues

Meeting notes

Our meeting notes can be found here.