GithubHelp home page GithubHelp logo
codenames

zxenonx / codenames Goto Github PK

View Code? Open in Web Editor NEW

This project forked from jporter-dev/codewords

0.0 0.0 0.0 3.96 MB

๐Ÿ‘พ Realtime Codenames game that you can play on your phone, TV, or laptop

Home Page: https://codenames.codecaffeinated.com

HTML 5.71% Python 19.05% Vue 55.77% JavaScript 19.47%

codenames's Introduction

codenames

Build Status

Realtime webapp implementation of the classic social word game, Codenames, designed to be played on a TV and mobile devices. Based on a project by sprek.

Blog Series

To read more about how this project came to fruition and how to build an app using the same technologies, follow the links below!

For content related to development, security, devops, AI, etc... check out SecDevOps.AI!

Large Player View Player - mobile Spymaster - mobile

Rules

Rules for codenames can be found here.

Development

The app uses flask as its back-end and webpack as a front-end dev server.

Prerequesites

  • npm
  • python
  • pip
  • (optional) Gunicorn
  • (optional) nginx
  • (optional) Foreman (development only)

Install Dependencies

# optional: use a virtualenv
virtualenv venv
source venv/bin/activate

# install python and js dependencies
npm run setup

# install dependencies separately
pip install -r requirements.txt
npm install
# or
yarn install

Development Servers

I recommend using Foreman. Foreman allows us to run both servers simultaneously in one terminal window.

# install foreman
npm i -g foreman
# start foreman
nf start
# both flask and webpack-dev-server should be running

# run servers separately...
# start the flask server on port 5000
npm run flask

# start webpack dev server with hot reload at localhost:8080
npm run serve
# navigate to localhost:8080 in browser

Production

Build

# install dependencies
npm install
pip install -r requirements.txt

# or install both at once
npm run setup

# build for production with minification
npm run build

# build for production and view the bundle analyzer report
npm run build --report

Running with nginx + Gunicorn

After installing Gunicorn and nginx...

  • Add your username and/or project folder path to the configs in the deploy directory.
  • Copy deploy/gunicorn.service to /etc/systemd/system
  • Copy deploy/codenames.nginx.conf to /etc/nginx/sites-available
  • Create a symbolic link from the new config to sites-enabled

codenames's People

Contributors

jporter-dev avatar joshporter1 avatar sprek avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.