Giter VIP home page Giter VIP logo

board-game-server's Introduction

Board Game Server

Backend server for a generic board game. Design goals:

  • Easy to extend for any turn-based game implementation
  • Effortless game hosting and joining, with no authentication
  • Typed realtime API via GraphQL subscriptions
  • Persistence via Redis so a game can be dropped and picked up at any time by anyone

Overview

Player One's Turn

Development

Server (port 4000)

  • cd server
  • yarn install to install JS/TS packages
  • yarn dev-redis to start Redis in Docker
  • yarn dev to start devserver and auto-generate nexus schema

For deployment, set the env vars:

  • REDIS_HOST: The host of the Redis server
  • REDIS_PORT: The port of the Redis server

Client (port 3000)

  • cd client
  • yarn install to install JS/TS packages
  • yarn dev to start devserver

For deployment, set the env vars:

  • REACT_APP_SERVER_ENDPOINT: The URL of the server
  • REACT_APP_URL_BASE: Used to determine share URLs, etc

Caveats

There is an assumption that a single game is hosted by a single Node server. Race conditions with Redis when multiple Node servers access the same game are not accounted for.

board-game-server's People

Contributors

fravic avatar

Watchers

 avatar James Cloos 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.