1.0.0 • Published 2 years ago

ref-ui v1.0.0

Weekly downloads
-
License
MIT OR Apache-2.0
Repository
github
Last release
2 years ago

ref-ui

This is the front-end for ref.finance.

Quick Start

To run this project locally:

  1. Prerequisites: Make sure you've installed Node.js ≥ 12
  2. Install dependencies: yarn
  3. Run the local development server connected to testnet: yarn start (see package.json for a full list of scripts you can run with yarn)

Architecture

This project consists of three layers:

  1. services is where communication (via the NEAR RPC API) to smart contracts happen.
  2. state is where the services are used and connected to react state management
  3. components and pages is where the view is created

Tests

Tests use React Testing Library and can be run with yarn test.

Code Formatting

This project uses Prettier to create consistently styled code. Prettier can be installed to auto-format on save for most editors. You can also run yarn prettier to check for styling errors and yarn prettier:fix to fix styling errors.