Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dxw/js-cop-games
A repo for the Javascript community of practice's games
https://github.com/dxw/js-cop-games
delivery-plus
Last synced: 21 days ago
JSON representation
A repo for the Javascript community of practice's games
- Host: GitHub
- URL: https://github.com/dxw/js-cop-games
- Owner: dxw
- Created: 2023-08-22T13:09:43.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-29T08:20:35.000Z (2 months ago)
- Last Synced: 2024-10-29T09:41:20.410Z (2 months ago)
- Topics: delivery-plus
- Language: TypeScript
- Homepage:
- Size: 1.2 MB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Colour Me Knowledgeable
A game built to help dxwers hone their JavaScript knowledge, based on [Colourbrain](https://bigpotato.co.uk/products/colourbrain).
## Developing locally
### Setup
To install all dependencies necessary for running the server locally, run:
```sh
script/setup
```
### Running the server
To start the local bun server, run:
```sh
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`](https://ngrok.com/docs/getting-started/) - 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](./doc/architecture/decisions/) to read them.
Architecture diagrams are available in [the diagrams directory](./doc/architecture/diagrams/).