Table of Contents
This project is inspired by Yahoo! Towers but is an independent work. It is not affiliated with or endorsed by Yahoo! or its entities. |
- Postgres
- pgAdmin
- pnpm
npm install -g pnpm
-
Clone the repository
git clone git@github.com:Chelny/youpi.git cd youpi -
Install dependencies
pnpm install
-
Create and fill the .env file
cp .env.example .env
-
Start Postgres server
-
Setup the database
pnpm db:setup
This will create the tables in database and add initial data such as rooms.
-
Run the client
pnpm dev
This command starts the development server, allowing you to access your application locally at http://localhost:3000.
-
Open your browser and go to http://localhost:3000.
-
Sign in with an existing account or create a new one.
-
Browse the rooms and tables:
- Click on a room to join it.
- Inside a room, you can interact with other players and see available tables.
-
Playing the game:
- Join a table to start a game.
- Use the control keys (check the Control Keys screenshot) to play.
- Watch the countdown and get ready to play.
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
- Add tooltip component (?)
- User changing username while in room(s) and table(s)
- Prevent user from accessing the profile page while in a game room (show prompt on click)
- Send websocket event to all rooms and tables to update the username if changed
See the open issues for a full list of proposed features (and known issues).
Distributed under the MIT License. See LICENSE.txt for more information.









