Table of Contents
When a repo admin installs Repo Gate as a Github App on their repo, the bot will immediately add a custom link to the project Readme. When a prospective user visits the repo, they can click the Get Collab Invite
link and be prompted to sign a message, proving they own some SPORK Token. If the user does own the token, they will be automatically invited as a collaborator with write
access to the repo.
To use the Repo Gate app, it will need to installed as a GitHub App on all the repositories you wish to gate.
After installing the app on a repo, a commit will automatically be made to the repo's README.md
(creating one if it doesn't already exist), adding a link to the bottom of the file for users to click to be added as a collaborator. The appearance of the link can be customized as long as the actual url doesn't change.
- Handle SPORK Token
- Make token address configurable
- Make collaborator permissions configurable
- Clean up UI
- Add support for ERC-721
- Add support for ERC-1155
- Keep collaborator access in sync with token balance
- Refactor to get
repo
andowner
frominstallation_id
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt
for more information.
Sam Wellander - @websurfer.eth
Many thanks to the Buidl Guidl and the amazing Scaffold-Eth-2 template that forms the base of this repo!