Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 2.35 KB

README.md

File metadata and controls

42 lines (28 loc) · 2.35 KB

POINT-IT-OUT:

Point-it-out is a augmented-reality review game you can play alone or with a friend. It works on any computer with a webcam. Users race against the clock to answer as many questions as possible, earning points along the way. Teachers, students, and game night hosts can create their own quizzes tailored to their needs. To check it out for yourself, head on over to https://point-it-out.herokuapp.com

Watch the project video

SCREENSHOTS:

Single Player Mode: screenshot1

Single Player end of game: screenshot3

Multiplayer Mode: screenshot2

Category creation/edit: screenshot4

PREREQUESITES:

After forking and cloning the project, run 'npm install' to download all the necessary dependencies. You must create two databases for the project: pointItOut and pointItOut-test.

You would need to get API keys for opentok and facebook to run this application. To run this application localy create a secrets.js file in the main directory and store the API keys in it.

GETTING STARTED:

The command 'npm run start-dev' will run the app in development mode on your local machine. To run the server and/or webpack separately, use 'npm run start-server' and 'npm run build-client.'

RUNNING TESTS:

All test files end with .spec.js. The command 'npm test' will run all tests for the project. You must have a database named pointItOut-test in order to run the test files.

App created using:

Node, Express, Sequelize, PostgreSQL, React, Redux, React-Redux, React-Router.

Aditional libraries and API's:

react-Konva, Opentok, clmtrackr, Diffyjs, butter-toast, react-confetti, react-countdown, recharts, passport-facebook

AUTHORS:

Alexandra Ash, Amy Berg, Kate Dubitski Kopitchinski, Sivan Gilead