# Codenames

[![Travis](https://img.shields.io/travis/matthewtole/codenames.svg?style=flat-square)](https://travis-ci.org/matthewtole/codenames) [![codecov](https://codecov.io/gh/matthewtole/codenames/branch/master/graph/badge.svg)](https://codecov.io/gh/matthewtole/codenames) [![license](https://img.shields.io/github/license/matthewtole/codenames.svg?style=flat-square)](./LICENSE)

A web based implementation of the board game [Codenames](https://boardgamegeek.com/boardgame/178900/codenames).

**NOTE: This project is a passion project by fans of the game and is in no way associated with the original game or its creators.**

It includes [additional rules](./docs/rules.md) for the game including [*drinking*](./docs/rules.md/#drinking-rules) and [*strip*](./docs/rules.md#strip-rules) rules.

## Installing

You will need Node v6 or newer and npm installed on your machine.

```shell
npm install
npm run build-client
npm run serve
```

## Developing

### Built With

* [React](https://reactjs.org/)
* [Semantic UI](http://react.semantic-ui.com)
* [socket.io](socket.io)
* [webpack](webpack.js.org)
* [Jest](https://facebook.github.io/jest/)


# Codenames

[![Travis](https://img.shields.io/travis/matthewtole/codenames.svg?style=flat-square)](https://travis-ci.org/matthewtole/codenames) [![Codecov](https://img.shields.io/codecov/c/github/matthewtole/codenames.svg?style=flat-square)](https://codecov.io/gh/matthewtole/codenames) [![license](https://img.shields.io/github/license/matthewtole/codenames.svg?style=flat-square)](./LICENSE)

A web based implementation of the board game [Codenames](https://boardgamegeek.com/boardgame/178900/codenames).

**NOTE: This project is a passion project by fans of the game and is in no way associated with the original game or its creators.**

It includes [additional rules](./docs/rules.md) for the game including [*drinking*](./docs/rules.md/#drinking-rules) and [*strip*](./docs/rules.md#strip-rules) rules.

## Installing

You will need Node v6 or newer and npm installed on your machine.

```shell
npm install
npm run build-client
npm run serve
```

## Developing

### Built With

* [React](https://reactjs.org/)
* [Semantic UI](http://react.semantic-ui.com)
* [socket.io](socket.io)
* [webpack](webpack.js.org)
* [Jest](https://facebook.github.io/jest/)


Switch to using the shields.io badge for codecov
Switch to using the shields.io badge for codecov [ci skip]
