Skip to content

design.md

Latest commit

 

History

History
73 lines (56 loc) · 1.72 KB

design.md

File metadata and controls

73 lines (56 loc) · 1.72 KB

Design

Architecture

The architecture is frontend - backend. The project can be run with a docker-compose file that runs everything. The pipeline allows the build and test of the project at every commit, and deploy the main branch.

The backend is written in Rust, and the frontend in Typescript. They communicate via WebSocket.

---
title: Architecture
---
flowchart TB

subgraph Docker
Nginx[[Nginx :80]] -- / --> Frontend
Nginx -- /ws --> Backend

Frontend -.-> Objects
Backend -.-> Objects
end

Client -- http --> Nginx
LoadTesting -- Websocket --> Backend
Loading 
---
title: Interactions
---
sequenceDiagram

participant Frontend
participant Backend

note over Backend,Frontend: Initialization

Frontend ->> Backend: Initiate Websocket Connection
Frontend ->> Backend: Username

Backend ->> Frontend: ID
Backend ->> Frontend: State of the board

note over Backend,Frontend: Every 300ms

Backend ->> Backend: Game Loop
Backend ->> Frontend: Changes

note over Backend,Frontend: User Input

Frontend ->> Frontend: User Input
Frontend ->> Backend: Direction
Loading

Dependencies

  • webassembly : run the rust code in the browser and interact with the page
  • websocket : communicate between the front and back
  • serde : transforms rust object instances to json

Sprints

  1. basic functionnalities
    1. select username
    2. the player can move on a grid
    3. the player can eat an apple and grow
    4. on the walls, loop back
  2. death
    1. the player loose if it hits any snake (himself or another player)
    2. the player loose if it hits a wall
  3. loosing / winning screen
    1. if a player loose, a popup shows
    2. at the end, a scoreboard is shown
  4. advance player movement
    1. handle rollback