The default Safe web interface.

Contributions, be it a bug report or a pull request, are very welcome. Please check our contribution guidelines beforehand.

Create a .env file with environment variables. You can use the .env.example file as a reference.

Here's the list of all the environment variables:

If you don't provide some of the variables, the corresponding features will be disabled in the UI.

Install the dependencies:

yarn

Generate types:

yarn postinstall

Run the development server:

yarn start

Open http://localhost:3000 with your browser to see the app.

ESLint:

yarn lint --fix

Prettier:

yarn prettier

Unit tests:

yarn test --watch

Build a static site:

yarn build

Serve the static files:

yarn serve

Launch the Cypress UI:

yarn cypress:open

You can then choose which e2e tests to run.

To create a new component from a template:

yarn cmp MyNewComponent

This repo has a pre-push hook that runs the linter (always) and the tests (if the RUN_TESTS_ON_PUSH env variable is set to true) before pushing. If you want to skip the hooks, you can use the --no-verify flag.

This app is built using the following frameworks:

• Safe Core SDK
• Safe Gateway SDK
• Next.js
• React
• Redux
• MUI
• ethers.js
• web3-onboard