https://github.com/5afe/safe-core-protocol-demo
https://github.com/5afe/safe-core-protocol-demo
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/5afe/safe-core-protocol-demo
- Owner: 5afe
- Created: 2023-07-11T08:49:24.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-10T02:56:17.000Z (over 2 years ago)
- Last Synced: 2025-03-27T16:49:12.883Z (about 1 year ago)
- Language: TypeScript
- Size: 3.57 MB
- Stars: 22
- Watchers: 7
- Forks: 23
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Safe{Core} Protocol Demo
This repository contain a demo for developing and using [Plugins](https://github.com/5afe/safe-core-protocol-specs/tree/main/integrations#plugins) from the Safe{Core} Protocol.
## Structure
The repository is separated into two parts:
- [Contracts](./contracts/) contains the sample contracts and scripts to deploy them
- [Web App](./web/) contains the web app to configure and use the sample contracts
## Make it your own
To get started with your own plugin you can fork/ copy this repository and adjust the existing code.
Follow the instructions in the [Contracts](./contracts/) folder to create a Plugin for your use case. You can then register the plugin on a test registry and it will be visible on [Demo App](https://5afe.github.io/safe-core-protocol-demo).
This [Demo App](https://5afe.github.io/safe-core-protocol-demo) can be used as a [Safe app in the Safe{Wallet} Web](https://app.safe.global/share/safe-app?appUrl=https%3A%2F%2F5afe.github.io%2Fsafe-core-protocol-demo&chain=gor) interface to add the Plugin to a Safe.
To configure your Plugin it is necessary to create a web app. For this follow the instructions in the [Web App](./web/) folder. A simple way to host your web app is to use [GitHub pages](https://pages.github.com/). For this you can use the `yarn deploy` script.
Important don't forget to update your [Plugin Metadata](./contracts/README.md#plugin-metadata).