Git Product home page Git Product logo

codenames's Introduction

Codenames

Play Codenames against software which uses a word embedding model.

The Codenames application in this repo consists of both a server and client.

The server exposes an API to interact with the Codenames engine (i.e. for generating clues and making guesses). It is written in Python and uses gensim on the engine side and Flask on the web side.

The client renders a UI and manages the game state. It is written in JavaScript using React.

Development

Prerequisites

  • python3 & pip3
  • node & npm

Setup

  • Clone this repo
  • Install server dependencies: codenames/server$ pip3 install -r requirements.txt
  • Install client dependencies: codenames/client$ npm install
  • Download a pre-trained binary fastText model from https://fasttext.cc/docs/en/crawl-vectors.html to codenames\server\i18n

Note: Only the german binary model is supported for now: cc.de.300.bin.gz

Run the applications

  • Start the server: codenames/server$ export FLASK_APP=server.py && python3 -m flask run
  • Start the client: codenames/client$ npm start
  • Open http://localhost:3000 in your web browser

Note: The server takes a long time to get ready while loading the huge fastText model into memory.

Docker

A Dockerfile is provided to create a self-contained image with:

  • nginx front server delivering the static client assets and reverse proxying to the app server
  • Gunicorn app server running the Python backend

To create a Docker image run: codenames$ docker build -t codenames .

To start the Docker container run: $ docker run -p 8080:80 -it codenames

Note: This will bind the exposed port 80 to your host port 8080.

codenames's People

Contributors

alimfeld avatar

Watchers

 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.