Giter Club home page Giter Club logo

crummytile's Introduction

Crummytile

Open source web app for playing rummikub and other tile/card games

image

Getting started

Server

The game server is a Node app serving WebSocket connections, files are in /server.

To run, cd server then:

  1. npm install to install dependencies
  2. npm start to start the server
  3. npm build to rebuild the server files from source (Typescript) if you change them (must restart server).

Web Client

The web client is a React app, files are in /web-client.

To run, cd client then:

  1. npm install to install dependencies
  2. npm start to start the web client dev server. Will automatically rebuild if files in web-client are changed so you don't need to restart.
  3. npm build to create a production build if necessary.

Shared files

Typescript files shared between the client and server are in /shared. If you are just running the game server/client and not changing anything, you can ignore this part. If you are changing any files in /shared, you need to first cd shared and then:

  1. npm install to install dependencies
  2. npm watch to start the file watcher, which will automatically rebuild if any .ts files in /shared change
  3. npm build to create a production build if necessary

crummytile's People

Contributors

dandelany avatar

Watchers

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