Skip to content

Latest commit

 

History

History
38 lines (22 loc) · 1.3 KB

README.md

File metadata and controls

38 lines (22 loc) · 1.3 KB
Raw

Colour Me Knowledgeable

A game built to help dxwers hone their JavaScript knowledge, based on Colourbrain.

Developing locally

Setup

To install all dependencies necessary for running the server locally, run:

script/setup

Running the server

To start the local bun server, run:

script/server

To allow other people to join the game running locally you'll need to share your port. There are a couple of ways you can do this.

  1. Use ngrok - installed with the setup script. You'll need to create an account with Ngrok for this.
  2. Use VS Code's terminal port sharing - we've had some issues with this not working very well locally, but you may have more luck!

If you're developing solo, you can simulate the game being played by multiple players by opening the game in multiple tabs.

Extensions

A list of recommended extensions to help with the developer experience can be found in .vscode/extensions.json. You may be prompted to install these when opening the repository in VS Code.

Architecture

This repo uses ADRs, head to the ADR directory to read them.

Architecture diagrams are available in the diagrams directory.