Skip to content

README.md

Latest commit

 

History

History
26 lines (21 loc) · 769 Bytes

README.md

File metadata and controls

26 lines (21 loc) · 769 Bytes

Objective

A companion app designed for friends to choose and play games together! Easily filter through Board Games, Nintendo Switch, and PS5 collections to find the perfect multiplayer experience for your gathering with your own collection.

Configuration

  1. Modify the 'games.ts', 'videoGames.ts' to your own collection
  2. Change 'vite.config.ts' base path to your Repo

Run and deploy Github page

  1. Install dependencies: npm install gh-pages
  2. Update vite.config.js base to your Repo project name.
  3. Run the app: npm run deploy
  4. Setup your Repo to Pages Branch as 'gh-pages'

Run Locally

Prerequisites: Node.js,

  1. Install dependencies: npm install
  2. Build the app: npm run build
  3. Run the app: npm run dev