Skip to content

readme.md

Latest commit

 

History

History
77 lines (51 loc) · 1.95 KB

readme.md

File metadata and controls

77 lines (51 loc) · 1.95 KB

Developing Splendor

Install Docker

Go to docker and install docker desktop (will install docker compose with it).

Initialize submodules

The LobbyService submodule must be initialized.

git submodule init
git submodule update

Running a setup

In general

Start with a terminal in the root of the folder (likely "f2022-hexanome-04")

cd setup/{setup name}
docker compose up --build

List of setups

has-server-client

  • The server needs to successfully build for this to work.
  • The client needs to successfully build for this to work.
  • Used for running the whole game all together.

no-client-server

  • Used for testing/debugging the client & server.

no-client

  • The server needs to successfully build for this to work.
  • Used for testing/debugging the client.

no-server

  • The client needs to successfully build for this to work.
  • Used for testing/debugging the server.

Client development (ones with no client included)

You will need to install the dependencies to build/debug the client.

From the root directory:

cd client
npm install --save-dev

Then start the development server for live updates:

npm run dev

Now, you may access the live debug client here.

Server development (ones with no server included)

Open the server folder using Intellij, it should set up everything for you.

Connecting to the client (if it has)

A web server will have been created for the client, which you can access with this link: http://localhost:36104.

Updates to the code

If you happen to change branches, update the code for the server and/or client, you must rebuild the docker images. An easy way to do that is to add --build to the docker compose command.

docker compose up --build