YOVI 🎯

Claim all three sides of the triangle. Sounds simple. It's not.

🌐 Play now: https://yovi.alejandrosanclaudio.com/
📝 Documentation: https://arquisoft.github.io/yovi_en1b/
⛓ API documentation: https://yovi.alejandrosanclaudio.com/api-docs/
💻 Presentation: https://canva.link/lxpjjo2vbixes10

---

✨ Welcome to YOVI

YOVI is a full-stack strategy game built as a monorepo. It combines a React frontend, a Node.js users service, a Rust game engine, and MongoDB-based local infrastructure.

👥 The Team

Contributor	Git Account	Role
Tobias Navrat	@Th0be	Frontend
Ahmet Bilal Yazıcıoğlu	@bilalyazicioglu	Game Logic & Bots
Ignacio Hoyos Diego	@nacho50900	Backend
Alejandro de San Claudio Mesa	@UO300896	Database and DevOps

---

🧱 Project Structure

yovi_en1b/
├── webapp/       React + Vite + TypeScript + E2E tests
├── users/        Node.js + Express + MongoDB
├── gamey/        Rust game engine & bot
├── mongo-init/   JavaScript + MongoDB
├── docs/         Arc42 architecture docs
└── load-tests/   Artillery

---

🎮 What can you do?

Feature	Description
🔐 Authentication	Register and log in securely to keep track about your games
💥 Game Variants	Play special modes such as the one with explosion
🗺️ Board Sizes	Choose between different board sizes for each match
🧑‍🤝‍🧑 vs Player	Play locally against another player on the same device
🤖 vs Bots	Challenge bots powered by several strategies
🕘 Game History	Browse previous games and review what happened
🏆 Leaderboard	Compare results and rankings with other players
📊 Statistics	Track wins, losses, and performance over time

---

🚀 Quickstart

🐳 Docker (recommended)

docker-compose up --build

Service	URL
🌍 Web App	http://localhost
🔌 Users API	http://localhost:3000
🧠 Gamey Engine	http://localhost:4000
🗃️ Database	mongodb://localhost:27017/app_database

🛠️ Local (no Docker)

# Backend
cd users && npm install && npm start

# Frontend
cd webapp && npm install && npm run dev

# Game engine
cd gamey && cargo run

---

⚙️ Scripts

🌐 Webapp

Command	Description
npm run dev	Start dev server
npm test	Run unit tests
npm run test:e2e	Run end-to-end tests
npm run start:all	Start webapp + users together

🧩 Users

Command	Description
npm start	Start the service
npm test	Run tests
npm run test:coverage	Run tests with coverage report

🦀 Gamey (Cargo)

Command	Description
cargo build	Build the engine
cargo test	Run tests
cargo run	Run the engine
cargo doc	Generate docs

🗄️ Database (MongoDB)

Command	Description
docker-compose up -d mongodb	Start the database in the background
docker-compose stop mongodb	Stop the database without deleting the instance
docker-compose down	Shut the environment down

---

📚 More info

• 📖 Architecture and documentation: docs/
• 🧪 Service-specific setup: see the README files in each subproject

---

Built with ❤️ at the University of Oviedo — ASW 2025/26