Spyfall

Web page to play Spyfall.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Demo

Prerequisites

All the listed prerrequisites must be installed in order to use the application.

• Node js
• Yarn
• Mongo DB
• React

Installing

• Clone repository using git

git clone https://github.com/jodorganistaca/Spyfall.git

• Install dependencies from package.json

yarn install

• Install dependencies from package.json in front (react)

cd front && npm install

Running the application

• Run the application in back

yarn start

• Run the application in front

cd front && npm run dev

• The application uses Google OAuth 2.0 and Facebook OAuth and therefore is required, inside a file named .env in root directory of the project:

  GOOGLE_CLIENT_ID = <GOOGLE_CLIENT_ID>
  GOOGLE_CLIENT_SECRET = <GOOGLE_CLIENT_SECRET>
  MONGO_URI = <MONGO_URI of the MongoDB Atlas database.>
  FACEBOOK_CLIENT_ID=<FACEBOOK_CLIENT_ID>
  FACEBOOK_CLIENT_SECRET=<FACEBOOK_CLIENT_SECRET>

• Also, for personalized collections naming, change default.json in config:

    
{
  "dbName": "dbName",
  "usersCollection": "usersCollection",
  "matchesCollection": "matchesCollection",
  "questionsCollection": "questionsCollection",
  "locationsCollection": "locationsCollection"
}

Built With

• React - Used for the front
• Node js - Used for the back
• Mongo DB - Database for user and other collections like movies, series, books, exercise
• Ant Design - For some component in the UI
• Material-UI - For some component in the UI
• i18n - For locale-based components
• Next.js - For easier mobile integration (PWA)

Authors

• José Daniel Organista Calderón - github

• Juan Sebastian Bravo Castelo - github

License

This project is licensed under the MIT License - see the LICENSE.md file for details