Installation Guide

Setup

In order to get started quickly, you need to follow these steps:

• Download the source code
• Setup client:
  • Build it yourself:
    • Install npm using apt package manager: sudo apt install npm, or directly from the official website
    • In src/client, run the instructions below.
    • The executable program can be found in the build folder
• Setup server:
  • Install Docker
  • Go to the src/server directory.
  • Build the Docker image using docker build -t teamcode .

Building and running

Client

npm install
npm run build

Server

• Run the Docker image generated in the setup section using docker run
  • The server runs inside the container and listens on port 12345
  • To run the server interactively and map the container port to a host port, run docker run -itp <host-port>:12345 teamcode)
  • The server hosts files inside /app/file_root in the container. By default, this folder is ephemeral, but it can be mapped to a folder on the host system using docker run's --mount option, e.g. by adding --mount src=/path/to/host/folder,dst=/app/file_root,type=bind after docker run in the previous command.