Skip to content

Hossein-79/twins

Repository files navigation

Logo

Twins

A simple and intuitive web application built with Django that helps you verify a smart contract's validity on Algorand blockchain.

View Demo

ℹ️ About The Project

Homepage Screen Shot 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.

📸 Screenshots

🔗 Prototype UI design on figma

💻 Technologies used

🔢 Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Installation

  1. Clone the project's repository onto your device.
~ git clone https://github.com/Hossein-79/twins.git
  1. Cd into the cloned folder.
~ cd twins
  1. Install nodejs dependencies in order to be able to use tailwind.
~ npm install
  1. Install the python dependencies.
~ pip install -r requrements.txt
  1. Get a GitHub API key from here and replace the following line inside twins/github.py:
g = Github("[YOUR_API_KEY]")
  1. Run the following commands to create the database.
~ python3 manage.py makemigrations
~ python3 manage.py migrate
  1. Start the local server on port 8000 and watch for changes.
~ python3 manage.py runserver
  1. (Optional) Watch for CSS changes.
~ npx tailwindcss -i ./twins/static/style.src.css -o ./twins/static/style.css --watch

🤝 Contributing

Twins was developed for the Algorand GreenHouse Hackathon. If you wish to improve this project, please fork the repo and create a pull request.

  1. Fork the Project
  2. Create your Contrib Branch (git checkout -b contrib/improvements)
  3. Commit your Changes (git commit -m 'Add some improvements')
  4. Push to the Branch (git push origin contrib/improvements)
  5. Open a Pull Request

🪪 License

Distributed under the MIT License. See LICENSE for more information.

🤙 Contact

If you have any questions or suggestions regarding this project feel free to reach either of us.

✉️ amousavig@icloud.com

✉️ ho.arabi79@gmail.com

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •