Rock Paper Scissors (RPS) Tournament Website

A fully functional Website for hosting a Rock Paper Scissors Tournament for your school events

RPS-Tournament is a webapp for hosting a tournament of the classic game of Rock Paper Scissors! It was made with an 8-bit retro design with aggressive red and orange colorscheme. Students will join the tournament on their phones while the hosts will operate the game using the admin page.

Important

This project is no longer being worked on. Feel free to download, use it, fork it and do whatever you want to with the code under the GPL-2 license. There will be no information regarding contributions unless this project receives enough attention to warrant continued support.

Features

• Create Players with 7-digit student IDs
• Randomly choosing two contestants to FIGHT
• Rock Paper Scissors Functionality (obv)
• End Game screen to show top 3 players and credit to its creators
• More features are presented within the Frontend and API README.md files

Table of Contents

• Installation
• Hosting
• Usage
• Project Structure
• Creators

API

• API Structure

FrontEnd

• Routes
• Frontend Structure
• Links

Installation

1. Download Requirements

• npm
• git

2. Download Project

Open your Terminal application and type:

git clone https://github.com/devaine/RPS-Tournament.git

3. Install dependencies:

cd into downloaded directory and do the following:

npm i # npm install but lazier

Hosting

Option 1: Local Host

Run app:

npm run dev # hosts both api and frontend using turbo

Option 2: Remote Host

Create a secret called PROD_URL. PROD_URL will be the url of the website you're hosting this project on (make sure to add https://). Follow this guide to learn how to create a secret.

Build the project, replace your_tag_name with your preferred tag:

docker buildx build --secret "id=PROD_URL" -t <your_image_name> . # builds project using your secret

Run your built image, (container port will always be 3003)

docker run -p 3003:3003 <your_image_name> # runs the docker image

Make sure you port forwarded 3003 with your computer's IP and you should be good.

Usage

Project Structure

Split between two apps:

1. API
2. Frontend

Tech Stack

• Typescript as our primary language
• Turbo for automating frontend and API production builds

Creators

devaine	papatenko	lancefinke	AngelAJH	Taylor Wiedeman
lead backend developer	lead frontend developer	helped start the project and backend	created our colorful cast of profile pictures	created the beautiful icons along with the animated background