From 658a2f343ea58d4712c313c7d65e19ab3db48020 Mon Sep 17 00:00:00 2001 From: Aditi Date: Wed, 3 Jul 2024 22:46:41 +0530 Subject: [PATCH 1/2] Update README.md --- README.md | 144 +++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 132 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 4ec6048..bcfcdae 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,38 @@ -# ChainzRegistry + +

ChainzRegistry

+

+

-## Land Registry using Blockchain +
+ + Typing SVG + +
+
-## Problem it Solves: +## :zap: About Us: A digital platform for secure and transparent land transactions. +
+### Key Features: +Online transactions, AI/ML for price analysis, E-Vault for document safety, Reward system and a Bored button. +
+### 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/) +
+ + +
+

High VoltageTech Stack:

+
-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 @@ -23,14 +44,15 @@ Key Features: Online transactions, AI/ML for price analysis, E-Vault for documen 9. NFT.Storage 10. Hardhat + +
-## 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 + + ## ⚡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: @@ -72,6 +94,104 @@ 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 + +
+

:pushpin:Project Flowchart:

+
+
+ + +
+

⚡Contribution Guidelines:

 + + + * **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! + +
+ +
+ + + + + +## :zap: Featured In: + + +
+

Open Source Programs

+
+ + + + + + + + + + + +
Event LogoEvent NameEvent Description
GSSoC 24GirlScript Summer of Code 2024GirlScript 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.
+
+ +## ✍️ 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:

+
+ +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. +
+ + +
+

License:

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

Our Contributors ❤️

+
+

Thank you for contributing to our repository

+ + + +
+ + +
+ +
+

Support

+
+ +
+ Don't forget to leave a star for this project! +

+ +Go to Top + + From 0d1eb081f06ad1355c192b0d3d58c6e96345bc4f Mon Sep 17 00:00:00 2001 From: Aditi Date: Wed, 3 Jul 2024 22:48:06 +0530 Subject: [PATCH 2/2] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bcfcdae..35f0d69 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@
-## :zap: About Us: +## :zap: About Us : A digital platform for secure and transparent land transactions.
### Key Features: @@ -49,7 +49,7 @@ Check out the deployed website [here](https://noplaybutton-41656.web.app/) - ## ⚡Getting Started: + ## ⚡Getting Started : ### To Run Application Locally: