stwiname / Cryptoships

Ethereum based Battleship game

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Battleship

A blockchain based take on the classic battleship game

Packages

Development

Getting started

  1. Clone the repo
  2. Install dependencies with yarn
  3. Build the source files with yarn build
  4. Install truffle: npm i -g truffle

Running tests

Currently only the contracts package has tests

  1. Run npx truffle develop from packages/contracts directory
  2. yarn test

Running locally

  1. Run a local ethereum blockchain in a separate terminal truffle develop from packages/contracts directory
  2. Start the Oracle node packages/oracle --secretKey <secret-key> --web3Endpoint ws://localhost:8545
    • The secret key is one of the private keys that is logged by truffle
    • This will create a new game
  3. Start serving the website yarn start
  4. Setup metamask
    • If not installed install the metamask browser extension
    • Import one of the private keys from step one, preferably not the same one as the Oracle
  5. Navigate to http://localhost:8000/<game-address> in your browser
    • The game address should be logged by the oracle

About

Ethereum based Battleship game


Languages

Language:TypeScript 81.9%Language:Solidity 11.5%Language:JavaScript 5.4%Language:HTML 1.2%