Skip to content

Steditor/yard

Repository files navigation

Yard

Simulate running around on a yard with many people represented as one or multiple colorful pixels.

Setup

Create a local.config.json according to the template in local.config.json.example. Take note of the port you specify for the express server, you will need it both for development and deployment.

Run npm install in the main directory to install all packages for both server and client.

Development

Run npm run dev in the main directory to start server and client in watch mode. Access the frontend via the server URL localhost:{{EXPRESS_PORT}} which serves as proxy for the vue-cli dev-server.

Deployment

Docker

Deploy the docker image defined in Dockerfile. Remember to set the environment variable MONITOR_PASSWORD to a secure password. The image exposes the express server on port 2567.

PM2

Install PM2 on your server. Run .deploy/deploy.sh from the project's root directory. The script will install all dependencies and build both server and client. Afterwards it uses PM2 to run the application.

Setup your reverse proxy according to the colyseus manual. Remember to put in the EXPRESS_PORT you specified during setup.

Server monitoring

The server exposes the Colyseus Monitoring Panel under URL:PORT/colyseus. Use admin and your local MONITOR_PASSWORD to login.