Git Product home page Git Product logo

testdrivennode's Introduction

testdrivennode

Test Driven Node.js Precompiler for Codemash 2014

Build Status

Getting started

  1. Install Node.js
  2. Clone this repo, change into the project directory, and run npm install
  3. To run the server, open a new terminal and nodemon app.js
  4. To run the unit tests, run npm test
  5. To run all tests, run npm run-script test-all
  6. To re-run the tests each time a file changes, open a new terminal and nodemon --exec npm test

API

  • POST /games #create - starts the game.
  • GET /games/:id #show - game state
  • PUT /games/:id #update - used once per game to place the ships
  • POST /games/:gameId/shots #create - this is how the user ends a turn

JSON Structure

Game

{
  status: ("setup" | "inprogress" | "won" | "lost"),
  turn: ("yours" | "opponents"),
  primaryGrid:
      [
        [{state:"none", ship: "ship"}, {state:"hit", ship:"ship"}, {state:"none", ship:"ship"}],
        [{state:"miss"}, {state:"miss"}, {state:"miss"}],
        [{state:"none"}, {state:"none"}, {state:"none"}]
      ]
  trackingGrid:
      [
...
      ]
}

Shot

{
  x: 0,
  y: 1,
  hit: [true | false],
  sunk: ["none sunk" | [shipType]]
}

Frontend

The frontend JavaScript, HTML, and CSS located in /public are generated. Visit this repo to make changes.

testdrivennode's People

Contributors

theotherzach avatar tkaufman avatar searls avatar

Watchers

Andrew Dunkman (he/him) 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.