aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/DEV.md
blob: 6061a1beea1182890a09d67d0e3c7a1ab340b7d1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# Architecture

* Reverse proxy server (Nginx)
* API server (Golang + Echo)
* App server (TypeScript + Remix)
* Database (PostgreSQL)
* Worker (Golang + Swift + WebAssembly)
    * WIP, not merged into `main` branch

# Dependencies

* Docker
* Docker Compose
* Node.js 20.0.0 or later
* Npm
* Go 1.22.3 or later

# Run

1. Clone the repository.
1. `cd path/to/the/repo`
1. `make init`
1. `make up`
1. Access to http://localhost:5173.
    * User `a`, `b` and `c` can log in with `pass` password.
    * User `a` and `b` are players.
    * User `c` is an administrator.