Skip to content

lukehorak/gamebox

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GameBox

Description

Play party games with friends at https://gamebox.netlify.com!

Screenshots

Home Page

Home Page

Lobby

Lobby

Game Lobby

Game Lobby

Rules

Rules

Categories

Categories

Host Is Picking a Category

Host Category

Question

Question

Voting Page

Voting Page

Busted!

Busted

Project Setup

  1. Fork this repo
  2. Clone to your machine

Getting Started

  1. Update the .env file with your correct local information
  2. Install dependencies: npm i
  3. Fix to binaries for sass: npm rebuild node-sass
  4. Run migrations: npm run knex migrate:latest
  5. Run the seed: npm run knex seed:run
  • Check the seeds file to see what gets seeded in the DB
  1. Run the server: npm run local
  2. Visit http://localhost:8080/

Environment Variables

Add environment variables for:

(replace values inside < > with the appriate values)

API (/api/.env)

DEV_DATABASE_NAME=<dev db name>

DEV_DATABASE_USER=<dev db username>

DEV_DATABASE_PASSWORD=<dev db password>

PROD_DATABASE_NAME=<prod db name>

PROD_DATABASE_USER=<prod db username>

PROD_DATABASE_PASSWORD=<prod db password>

HOST=<address of the db host>

Client (/client/.env)

REACT_APP_API_URL=<url where the api is deployed>

Contributing

  1. Fork and clone this repo!
  2. Add new remote as the master branch $ git remote add absolute-master https://github.com/lukehorak/gamebox
  3. Pull from master to get latest stable version before working git pull absolute-master
  4. Checkout and switch to a new branch named as the feature you're working on get checkout -b pwn-noobs
  5. Do local tests
  6. Push to your forked copy's branch on Github (not absolute-master) git push origin pwn-noobs
  7. Open pull request
  8. Wait for merge

Dependencies

  • Node 5.10.x or above
  • NPM 3.8.x or above

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •