mancala/apps/frontend/README.md

41 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

2024-06-16 23:31:33 +03:00
# Mancala Frontend
2024-03-24 03:13:40 +03:00
2024-06-16 23:31:33 +03:00
The web user interface for the Mancala project, written in React.
## Getting Started
### Install Packages
```bash
yarn install
```
### Start in Development Mode
2024-03-24 03:13:40 +03:00
```bash
yarn dev
2024-06-16 23:31:33 +03:00
```
### Development Dependencies
This package links the local packages `@mancala/core` and `mancala.js`. Build them first with `yarn build:packages` in the repo root.
### Login
Every visitor has a Keycloak session (see `apps/keycloak`): the first visit logs in as a new guest without any
form, and the account menu on the home page lets guests log in or sign up. Run Keycloak locally with
`docker compose up keycloak` in `apps/`; the dev server must run on port 1234, which the `mancala-web` client allows.
| Build variable | Default |
|---|---|
| `SERVER_ADDRESS` | `http://localhost:5005` |
| `WS_SERVER_ADDRESS` | `ws://localhost:5005` |
| `KEYCLOAK_URL` | `http://localhost:8080` |
### Docker Build
From the repo root:
```bash
docker build -f apps/frontend/Dockerfile --build-arg SERVER_ADDRESS=http://localhost:5000 --build-arg WS_SERVER_ADDRESS=ws://localhost:5000 --build-arg KEYCLOAK_URL=http://localhost:8080 -t mancala-frontend .
```