README.md

Overview

• Online multiplayer game based on board Settlers of Catan.
• Web app. All JS.
• Tech stack:
  • Front end: Vue, Jquery, SVG
  • Caching: Redis
  • DB: MongoDB
  • Real time Communication: Socket.io (Web Socket)
  • Back end: Node.js

Setup

• First install Redis.
  • Ubuntu: Install Redis from http://redis.io/download
  • Mac: Install Redis from https://medium.com/@petehouston/install-and-config-redis-on-mac-os-x-via-homebrew-eb8df9a4f298#.4t3pcn264
  • Mac: if you have brew, then "brew install redis"
• Start redis server

  $ redis-server

• Make sure npm and Node.js (v 7.4.0+) are installed.
• Clone the repository and cd to project directory, and type npm install to install all the dependencies.

Start server

Make sure Redis is running locally on port 6379, then simply cd to project directory, and

$ npm start

Test

• Log in/ Sign up
• Then you should be able to see the game lobby. You can join an existing game (if there is one in the lobby), or start a new game (continued saved game is not supported now).
• Once there are 3 ~ 4 players, game starts. (So you may need to log in with 3~4 different accounts in different broswers.)
  • Click on vertice to build a settlement/ upgrade existing setterment.
  • Holding Ctrl, click two adjacent vertices to build a road or ship.
  • Click on Finish to finish the game.

Document

• Check out Wiki if you have question about communication pattern and socket event tags.