lukasgor / rpsls

Home Page:rpsls-sigma.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Rock-Paper-Scissors-Lizard-Spock

Getting started

Rock Paper Scissors Lizard Spock game built on Ethereum. You need to have a metamask installed in order to interact with the app. Test version running on ropsten network: https://rpsls-sigma.vercel.app/

Installation & running locally

It's recommended to use node v14.17.0, if you'r a nvm user, simply run nvm use inside the project.

Install all dependencies:

yarn install

Run the app locally:

yarn dev

By default the app is connected to Ropsten test network, if you want to run the app in other environment, check the deployment section.

Contributing

Creating a PR

All code should be submitted through PRs and approved by at least one code owner. Code owners are listed in the CODEOWNERS file. When creating a PR, follow the PR template and provide whatever information is required for people to understand the why, what and how of your changes.

Conventional commits

We use conventional commits to keep our commits readable, but also to automatically handle our release flow and generate changelogs in the future.

Deployment

If you want to deploy the contracts to other networks, create a .env file based on .env.example in the root of the project. Next you need to fill DEPLOY_ACC_MNEMONIC and RPC_URL and run yarn compile:contracts && yarn deploy:contracts. After that copy the rps factory address and hasher outputted after deployment and paste it to FACTORY_ADDRESS and HASHER_ADDRESS accordingly in .env file.

Pushing to a branch

The following happens when a commit is pushed to a branch other than master:

  1. Dependencies are installed.
  2. Linter is run.
  3. Branch version of the app is deployed via Vercel

Pushing/merging to master

App is automatically deployed to: https://rpsls-sigma.vercel.app/

About

rpsls-sigma.vercel.app


Languages

Language:TypeScript 78.3%Language:Solidity 17.7%Language:JavaScript 3.3%Language:Shell 0.7%