rthomare / rout3r

An open source web3 based project that routes users via user defined short cuts.

rout3r

An open source web3 based project that routes users via user defined short cuts.

This is a React + TypeScript + Chakra UI boilerplate to be built with Vite. It also includes Husky and a pre-commit hook that runs yarn format.

What's inside?

• ReactJS
• Vite
• TypeScript
• Chakra UI
• Framer Motion
• Jest
• Testing Library
• Eslint
• Prettier
• Husky

+ other smaller dependencies

Getting started

1. Install yarn dependencies

   ## install yarn dependencies
   yarn

2. Install forge by following instructions here: https://book.getfoundry.sh/getting-started/installation

3. Serve with hot reload at http://localhost:5173.

   yarn dev

4. (Optionally) run in with local chain

   yarn dev --full

Develop the Contracts

All contract logic is located in the contracts directory. To compile and deploy the contracts see the README in the contracts directory.

Recommended VS Code extensions

• ESLint
• Prettier
• vscode-styled-components

Other commands

Lint commands

• Run eslint

  yarn lint

• Run eslint with fixing

  yarn lint:fix

Build commands

yarn build

Test commands

• Run tests with coverage (will open the coverage if all tests succeed)

  yarn test

• Watch tests

  yarn test:watch

Deploy command

yarn deploy

License

This project is licensed under the GPL License.