Skip to content

Commit

Permalink
Merge pull request #63 from Aditijainnn/Aditijainnn-patch-1
Browse files Browse the repository at this point in the history 
updated Readme.md #56
  • Loading branch information
@jaibhedia
jaibhedia authored Aug 10, 2024
2 parents 48fe511 + 0d1eb08 commit 736276f
Showing 1 changed file with 132 additions and 12 deletions.
144 changes: 132 additions & 12 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,38 @@
# ChainzRegistry
<a id="top"></a>
<h1 align="center">ChainzRegistry</h1>

<h3 align="center">
<a href="LICENSE"><img src="https://img.shields.io/static/v1?label=license&message=MIT&color=green"></a>
<img src="https://img.shields.io/badge/Ethereum-20232A?style=for-the-badge&logo=ethereum&logoColor=white">
<img src="https://img.shields.io/badge/Flutter-%2302569B.svg?style=for-the-badge&logo=Flutter&logoColor=white">
</h3>

## Land Registry using Blockchain
<div align="center">
<a href="https://git.io/typing-svg">
<img src="https://readme-typing-svg.herokuapp.com?font=Open+Sans&weight=300&size=31&pause=1000&random=false&width=435&lines=+Land+Registry+using+Blockchain" alt="Typing SVG" />
</a>
</div>
<hr>

## Problem it Solves:
## :zap: About Us :
A digital platform for secure and transparent land transactions.
</br>
### Key Features:
Online transactions, AI/ML for price analysis, E-Vault for document safety, Reward system and a Bored button.
</br>
### Demo:
Our Dapp is demonstrated in this video [here](https://youtu.be/9aHm6GLnaRo)

### Run Application on deployed website:
Check out the deployed website [here](https://noplaybutton-41656.web.app/)
<hr>

<!--------------------------------------------------------------TECH STACKS---------------------------------------------------------------------------------------->
<div>
<h2><img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Travel%20and%20places/High%20Voltage.png" alt="High Voltage" width="35" height="35" />Tech Stack:</h2>
</div>

Key Features: Online transactions, AI/ML for price analysis, E-Vault for document safety, Reward system and a Bored button.

## Technology Stack:
1. Ethereum Blockchain
2. Polygon/Matic
3. Dart
Expand All @@ -23,14 +44,15 @@ Key Features: Online transactions, AI/ML for price analysis, E-Vault for documen
9. NFT.Storage
10. Hardhat

</details>
<hr>

## Demo
Our Dapp is demonstrated in this video [here](https://youtu.be/9aHm6GLnaRo)

## Run Application on deployed website
Check out the deployed website [here](https://noplaybutton-41656.web.app/)

## To Run Application Locally
<!---------------------------------------------------------------------- HEADERS--------------------------------------------------------------->
## ⚡Getting Started :

### To Run Application Locally:

1. Clone the github repository and cd to the folder
2. Install the flutter 3.0.2, nodejs
3. Install ganache and truffle as shown below:
Expand Down Expand Up @@ -72,8 +94,106 @@ flutter run -d web-server --web-port 5555
9. Open the browser and the dapp will be running in http://localhost:5555/
10. Create mapbox api key from https://www.mapbox.com/ and Replace it with `mapBoxApiKey`in `constant.dart` file

## Project Flowchart

<details>
<summary><h2>:pushpin:Project Flowchart: </h2></summary>
<img src="screenshots/flowchart.png" height="450">
</details>
<hr>
<!---------------------------------------------------------------CONTRIBUTION GUIDELINES--------------------------------------------------------------------------->

<details>
<summary><h2>⚡Contribution Guidelines:</h2></summary>


* **Checkout and make your changes for the develop branch only:** When working on your contributions, switch to the **develop** branch in your local repository. This ensures that you are working on the latest version of the codebase.

* **Create pull requests only for the develop branch:** When you are ready to submit your changes, create a pull request (PR) targeting the **develop** branch. This allows the maintainers to review and merge your code into the main development branch.

* **Maintain contribution guidelines:** Each project may have its specific contribution guidelines. It's important to familiarize yourself with these guidelines before submitting your contributions. Adhering to these guidelines ensures consistency and helps maintain the quality of the codebase.

* **Format your commit message with the issue number:** When making commits related to an issue, follow the format **Fixes: #32 in your commit message. Replace 32 with the issue number you are addressing.** This helps track and manage issues more efficiently.

* **Attach a Postman response screenshot for backend tasks:** For tasks related to the backend, it is recommended to include a screenshot of the Postman response along with your pull request. This provides additional context and helps reviewers understand the changes made and their impact on the backend functionality.

* **Make your pull request descriptive and include examples:** When creating a pull request, provide a clear and descriptive explanation of the changes you made. This helps reviewers understand the purpose and significance of your contribution. Additionally, including at least one example that demonstrates the intended usage or effect of your changes can be beneficial.

* **Rebase your commits and optimize file changes:** When submitting your pull request, consider rebasing your commits into one commit and optimizing your file changes. This helps keep the commit history clean and makes it easier for reviewers to understand your changes.

Remember, following these guidelines will help ensure a smooth and efficient contribution process. Happy coding!

</details>

<hr>


<!------------------------------------------------------------------------FEATURED IN------------------------------------------------------------------------------>


## :zap: Featured In:


<div>
<h2><img src="https://github.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/blob/master/Emojis/Hand%20gestures/Flexed%20Biceps.png?raw=true" width="35" height="35" > Open Source Programs</h2>
</div>
<table>
<tr>
<th>Event Logo</th>
<th>Event Name</th>
<th>Event Description</th>
</tr>
<tr>
<td><img src="https://user-images.githubusercontent.com/63473496/153487849-4f094c16-d21c-463e-9971-98a8af7ba372.png" width="200" height="auto" loading="lazy" alt="GSSoC 24"/></td>
<td>GirlScript Summer of Code 2024</td>
<td>GirlScript Summer of Code is a three-month-long Open Source Program conducted every summer by GirlScript Foundation. It is an initiative to bring more beginners to Open-Source Software Development.</td>
</tr>
</table>
<hr>

## ✍️ Feedback and Support:

If you encounter any issues or have any feedback or suggestions, please open an issue in the Issues section of this repository. We appreciate your feedback and will respond as soon as possible.

<!-- Code of conduct -->
<div>
<h2><img src = "https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Hand%20gestures/Handshake.png" width="35" height="35"> Code of Conduct:</h2>
</div>

Please note that this project is released with a [Contributor Code of Conduct](./CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
<hr>

<!-- License -->
<div>
<h2><img src = "https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Objects/Page%20with%20Curl.png" width="35" height="35"> License:</h2>
</div>

[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)<br>
This project is licensed under the [MIT License](./LICENSE).

<hr>

<h2 align = "center">Our Contributors ❤️</h2>
<div align = "center">
<h3>Thank you for contributing to our repository</h3>
<a href="https://github.com/jaibhedia/ChainzRegistry/graphs/contributors">
<img src="https://contrib.rocks/image?repo=jaibhedia/ChainzRegistry" />
</a>
</div>


<hr>

<div>
<h2><img src="https://fonts.gstatic.com/s/e/notoemoji/latest/1f64f_1f3fb/512.webp" width="35" height="35"> Support </h2>
</div>

<div>
Don't forget to leave a star<img src="https://fonts.gstatic.com/s/e/notoemoji/latest/1f31f/512.webp" width="35" height="30"> for this project!
</div> <br>

<a href="#top" style="position: fixed; bottom: 20px; right: 20px; background-color: black ; color: white; padding: 10px 20px; text-align: center; text-decoration: none; display: inline-block; border-radius: 5px; font-family: Arial; font-size: 16px;">Go to Top</a>



## ❤ Thanks to all Contributors

Expand Down

0 comments on commit 736276f

Please sign in to comment.