Skip to content

kleros/kleros

Repository files navigation

Kleros

JavaScript Style Guide Tested with Truffle Conventional Commits Commitizen Friendly Styled with Prettier

Kleros core smart contracts.

Get Started

  1. Clone this repo.
  2. Run yarn to install dependencies and then yarn run build to compile the contracts.

Scripts

  • yarn run prettify - Apply prettier to the entire project.
  • yarn run lint:sol - Lint the entire project's .sol files.
  • yarn run lint:js - Lint the entire project's .js files.
  • yarn run lint:sol --fix - Fix fixable linting errors in .sol files.
  • yarn run lint:js --fix - Fix fixable linting errors in .js files.
  • yarn run lint - Lint the entire project's .sol and .js files.
  • yarn test - Run the truffle tests.
  • yarn run cz - Run commitizen.
  • yarn run build - Compile contracts.

Contributing

See CONTRIBUTING.md.

Learn how to develop arbitrable and arbitrator contracts here.