README.md

Rock Paper Robots

Built by Emma Lynn.

Play rock, paper, scissors with a robot to earn RoboCash™! Use your RoboCash™ to purchase items from the store for your collection. Items in your collection are 3D models rendered on the page with WebGL.

Full stack web application

• Frontend: React
  • 3D model rendering: WebGL with Three.js
• Backend: Express
• Database: Postgres with Prisma

Written for my final project for Modern Web Development at Utah State University.

Setup

Prerequisites

• node
• docker

Install dependencies

In the root of the project run

npm install

In the client folder run

npm install

Create .env file

Create a new file called .env in the root of the project and copy the contents of .env.example into it. Change the values of the variables to fit your application.

Setup the database

In the root of the project run

docker compose up -d

Then run

npm run migrate-reset

Running the application

In the root of the project run

npm run dev

Open and new terminal tab and navigate to the client folder and run

npm run dev

Visit your application at http://localhost:3000 (or whatever port you specified in your .env file)

NOTE: YOU MUST BE RUNNING BOTH THE CLIENT AND SERVER

Other Useful Commands

Generate and run migrations

npm run migrate-dev

Run prisma console

npm run console

Reset the database

This command deletes all data from the database and recreates all of the tables from the existing migrations.

npm run migrate-reset

npm run migrate-reset

Seed the Database

Seed script is found in prisma/seeds.ts.

npm run seed

Image Attribution

Icons

• Coin icons created by kliwir art - Flaticon
• Stone icons created by bastian 5 - Flaticon
• Paper icons created by Freepik - Flaticon
• Scissors icons created by Gulraiz - Flaticon

Models

• Cactus: Turbosquid
• Rubber Duck: Turbosquid
• Strawberry: Turbosquid
• Duck: https://codesandbox.io/p/sandbox/view-tracking-bp6tmc?file=/src/styles.css:8,6
• Penguin: Turbosquid
• Lightning: https://codesandbox.io/p/sandbox/view-tracking-bp6tmc?file=/src/styles.css:8,6
• Apple: https://codesandbox.io/p/sandbox/view-tracking-bp6tmc?file=/src/styles.css:8,6
• Candy: https://codesandbox.io/p/sandbox/view-tracking-bp6tmc?file=/src/styles.css:8,6
• Target: https://codesandbox.io/p/sandbox/view-tracking-bp6tmc?file=/src/styles.css:8,6

References

• Three.js: https://codesandbox.io/p/sandbox/view-tracking-bp6tmc?file=/src/styles.css:8,6