- Apps and @mancala/core depend on the packages in this repo through link: dependencies instead of the npm releases, so changes no longer need a publish - Root package.json gets a build:packages script that installs and builds both packages - Backend and frontend Docker images are built from the repo root so they can include the packages; compose builds them that way - Metro watches the packages folder and resolves their imports from the app's node_modules
1.7 KiB
1.7 KiB
Mancala Backend
This is the backend code for the Mancala project, written in Express.js.
Getting Started
Install Packages
yarn install
Start in Development Mode
yarn dev
Start in Release Mode
yarn build
yarn start
Development Dependencies
This package links the local packages @mancala/core and mancala.js. Build them first with yarn build:packages in the repo root.
Authentication
Clients log in with Keycloak (see apps/keycloak), either as a guest or with an account, and send the access token
over the WebSocket right after connecting:
{ "channel": "auth", "message": { "token": "<Keycloak access token>" } }
The server answers on on_auth with the user ({ id, name, isGuest }) or on on_auth_error and closes the socket
with code 4001. Other messages are ignored until the socket is authenticated, and connections that do not
authenticate within 5 seconds are closed. Send auth again with the new token after refreshing it.
User ids of Keycloak users are the token subject prefixed with kc:.
| Variable | Default | Purpose |
|---|---|---|
KEYCLOAK_ISSUER |
http://localhost:8080/realms/mancala |
Token issuer; must match the iss claim exactly |
KEYCLOAK_JWKS_URL |
issuer + /protocol/openid-connect/certs |
Where to fetch signing keys, if the backend reaches Keycloak at a different address |
KEYCLOAK_CLIENT_IDS |
mancala-web |
Comma-separated clients whose tokens are accepted |
LEGACY_USERKEY_AUTH |
true |
Also accept old clients that connect with ?userKey=<uuid> and the /register endpoint. Turn off once no released client uses it, because a userKey is not a secret the server can check |