Welcome to the Safe Apps Workshop monorepo. In this repository you will find some resources to showcase step by step how to integrate a Dapp with the Safe. Even if you are creating a new application or adapting an existing one you will be able to check here some examples explaining the key points.
| Project | Description |
|---|---|
| counter-onboard-frontend | Simple Counter Dapp implemented with React & Web3-onboard |
| counter-safe-app-frontend | Simple Counter Safe App implemented with React & Safe Apps SDK |
| faucet-backend | Simple Faucet backend |
| smart-contracts-hardhat | Hardhat Project with the Counter & Faucet contracts |
To use this repository we are assuming that you have git, node and yarn already installed.
Install project dependencies using:
yarn install
It is expected that counter-onboard-frontend and counter-safe-app-frontend are not working as a Safe App out of the box. To make them work you should follow instructions from counter-onboard-frontend or counter-safe-app-frontend.
We recommend you getting a quick look to the available scripts before starting with any of the guides.
To run the different projects you can use the following commands in the root directory:
Runs the Counter Dapp using Web3-onboard. In the first part of the workshop we will use the Web3-onboard Safe Module to use this Dapp as a Safe App \
After run the start script, open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Runs the Counter Safe App using Safe Apps SDK.
After run the start script, open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner.
Generates the test coverage report.
You can deploy your own Counter and Faucet contracts
Runs the Faucet backend in development mode
Runs the Faucet backend in production mode