blob: a9e9419d7ecffae731fe3659f584124208eaf11f (
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
# Rahanna
A peer-to-peer (P2P) chess game with a Terminal User Interface (TUI).
https://github.com/user-attachments/assets/fdbffd28-290c-4f4e-8336-fc0c8aaf729c
> _Disclaimer:_
> This project is a university exercise for a Distributed Systems class. While it seems to function correctly, Rahanna is not intended for production use. The UI opens network ports that should not be exposed in secure environments.
---
Rahanna enables two players to play chess directly via a TCP connection — no centralized server manages the game state. Moves are sent in real time over the network, and only the final outcome is stored.
- P2P gameplay over TCP.
- TUI-based interface.
- Lightweight REST API for user authentication and matchmaking.
- No need to know your opponent's IP address - just the unique game name.
Even though Rahanna is a P2P application, it relies on a central Rahanna API for:
- User authentication and registration.
- Match discovery.
No gameplay data is stored centrally — only metadata (e.g., game outcomes).
## Build
Make sure you have Go 1.24+ and Git installed.
```
$ git clone github.com/boozec/rahanna.git
$ # make all or
$ go build -o rahanna-ui cmd/ui/main.go
```
If you want to also makes up an API server, run
```
$ go build -o rahanna-api cmd/api/main.go
```
## Run
Now, you can just run the one (or two) executables you just builded after an environment setup:
```
export API_BASE="http://localhost:8080"
```
Or, if you also want to make up the API:
```
export POSTGRES_USER=postgres
export POSTGRES_DB=rahanna
export POSTGRES_PASSWORD=password
export DATABASE_URL="host=localhost user=postgres password=password dbname=rahanna port=5432"
export JWT_TOKEN="..."
export RAHANNA_API_ADDRESS=":8080"
export DEBUG=1
```
If you are more lazy, you just can make everything up thanks to Docker.
```
# Start the API and database
docker compose -f docker/api/docker-compose.yml up
# In another terminal, run the UI
docker run -e API_BASE=http://0.0.0.0:8080 -it --network host rahanna-ui:latest
```
|
