README.md

Rock Paper Scissors: A Force-Move Games POC

Setup

1. Install yarn

   brew install yarn
   

2. Set up your .env

   cp .env.example .env
   

Developement Info

To run a dev server:

1. Start ganache
   • Either using the app
   • Or by running ganache-cli in a different tab
2. Deploy the contracts:

   yarn truffle:migrate
   

3. Run the server:

   yarn start
   

4. In your browser make sure you have the local ganache network (probably localhost:8545) selected in metamask

To build:

yarn run build

To develop smart contracts

# compile project with tsc, and run `truffle compile` from within build/dist
yarn truffle:compile

# deploy smart contracts to a network
TRUFFLE_NETWORK=<named network in truffle.ts> yarn truffle:migrate

To run application tests in watch mode:

yarn run test:app

To run smart contract tests:

yarn run test:truffle

To run all tests (before submitting a PR):

yarn run test

To update dependencies:

yarn install

To add a dependency:

yarn add [package-name] - installs the latest version of the package

To update the version of a dependency:

yarn upgrade [package-name@version-number]

Project style

Please use the Sublime/VS Code package JsPrettier for formatting. Add the following changes to the prettier settings:

  "printWidth": 100,
  "singleQuote": true,
  "trailingComma": "all",

Current state: