
A simple and intuitive web application built with Django that helps you verify a smart contract's validity on Algorand blockchain.
View Demo
Twins allows you to easily compare an Algorand application with a source file on GitHub and make sure the same source has been deployed to the Algorand blockchain and get a badge to put in your Github readme. It will even know when there's a new commit and the new source file no longer reflects the deployed version, so the verified badge would get expired.
🔗 Prototype UI design on figma
To get a local copy up and running follow these simple example steps.
- Python (Download link)
- NodeJS (Download link)
- Clone the project's repository onto your device.
~ git clone https://github.com/Hossein-79/twins.git
- Cd into the cloned folder.
~ cd twins
- Install nodejs dependencies in order to be able to use tailwind.
~ npm install
- Install the python dependencies.
~ pip install -r requrements.txt
- Get a GitHub API key from here and replace the following line inside
twins/github.py
:
g = Github("[YOUR_API_KEY]")
- Run the following commands to create the database.
~ python3 manage.py makemigrations
~ python3 manage.py migrate
- Start the local server on port 8000 and watch for changes.
~ python3 manage.py runserver
- (Optional) Watch for CSS changes.
~ npx tailwindcss -i ./twins/static/style.src.css -o ./twins/static/style.css --watch
Twins was developed for the Algorand GreenHouse Hackathon. If you wish to improve this project, please fork the repo and create a pull request.
- Fork the Project
- Create your Contrib Branch (
git checkout -b contrib/improvements
) - Commit your Changes (
git commit -m 'Add some improvements'
) - Push to the Branch (
git push origin contrib/improvements
) - Open a Pull Request
Distributed under the MIT License. See LICENSE
for more information.
If you have any questions or suggestions regarding this project feel free to reach either of us.