ft(actions)

Author: siddhantprateek

.github/workflows/greetings.yml

@@ -0,0 +1,26 @@
+name: Greetings
+
+on: [pull_request_target, issues]
+
+jobs:
+  greeting:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+    - uses: actions/first-interaction@v1
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        issue-message: |
+            Thank you for creating an issue in the Pheno Application repository! 🚀
+            Our team will review the issue and respond to you as soon as possible. We appreciate your contribution to improving the application and making it even better.
+            Feel free to explore other parts of the repository, contribute to ongoing discussions, or even consider submitting a pull request if you're up for it! We value your involvement and look forward to working together to address any concerns you might have.
+            Happy coding! 💻✨
+        pr-message: |
+          Congratulations on submitting a pull request to the Pheno Application repository! 🎉
+          Our team will review your changes and provide feedback or merge it if everything looks good. 
+          Your contributions help us enhance the application and provide a better experience for our users.
+          Feel free to engage with the community, join discussions, and explore other areas of the repository. 
+          Your effort is valuable, and we're excited to have you as part of our development journey.
+          Keep up the great work and keep coding! 💪💼

.github/workflows/issue-stale.yml

@@ -0,0 +1,23 @@
+name: Close inactive issues
+on:
+  schedule:
+    - cron: "30 1 * * *"
+
+jobs:
+  close-issues:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/stale@v5
+        with:
+          days-before-issue-stale: 30
+          days-before-issue-close: 14
+          stale-issue-label: "stale"
+          exempt-issue-labels: 'bug,enhancement'
+          stale-issue-message: "This issue is stale because it has been open for 30 days with no activity."
+          close-issue-message: "This issue was closed because it has been inactive for 14 days since being marked as stale."
+          days-before-pr-stale: -1
+          days-before-pr-close: -1
+          repo-token: ${{ secrets.REPO_TOKEN }}

README.md

@@ -1,22 +1,53 @@
-<h1 align="center">Polychain</h1>
+![](./assets/polychain.png)
 
-<p align="center">Blockchain integration for Polyroot Infrastructure</p>
+> Blockchain integration for `Landate` Infrastructure
 
---- 
-## App Features
-
-### Tech Stack
+## Tech Stack
 - `NodeJs`
 - `Solidity`
 - `Truffle` - Framework for smart contract development.
 - `Web3.Js` - Smart contract interaction
 - `Cypress` - E2E Testing
 
-### 👌 Features
+### 👌 Contract Features
+
+The core of Polychain is a Solidity smart contract that facilitates property ownership, transfer, pricing, and shared ownership. Here's a breakdown of its features:
+
+- `Property Creation`
+  - Owners can create properties by specifying the location and price.
+  - Each property is represented by a unique token with an associated property ID.
+
+- `Property Transfer`
+  - Owners can transfer property ownership to another address.
+  - Ownership transfers are securely facilitated using the ERC721 standard.
+
+- `Property Purchase`
+  - Users can purchase properties by sending the required funds to the contract.
+  - The contract ensures that the purchase price matches the property's price.
+
+- `Property Price Update`
+  - Owners can update the price of their properties.
+  - An event is emitted to notify interested parties about the price change.
+
+- `Shared Ownership`
+  - Owners can share ownership of a property with others.
+  - Shared ownership is represented by assigning ownership shares to multiple addresses.
+  - Owners can adjust the ownership shares of each participant.
+
+- `Ownership Percentage Calculation`
+  - A function calculates the ownership percentage of a specific address for a given property.
+  - It takes into account the ownership shares assigned to that address.
+
+- `Nomination and Transfer of Shared Ownership (Future Enhancement)`
+  - A nomination feature can be added to facilitate the transfer of shared ownership to another address.
+
+#### Contract Deployment and Usage
+
+- To deploy the `Property` Smart Contract, compile and migrate it using the Truffle framework.
+- The contract provides a secure and decentralized way to manage property ownership and transactions.
+- Use the provided Ethereum wallet addresses and functions to interact with the contract.
+- The contract enforces ownership transfer rules and manages shared ownership transparently.
 
-- 
-- 
-- 
 
 ## Repository folder structure
 ```bash
@@ -34,4 +65,42 @@
 ├── test # contract testing code
 ├── truffle-config.js # truffe configuration -> https://trufflesuite.com/docs/truffle/reference/configuration/
 └── yarn.lock
-```
+```
+
+## Installation
+
+- Clone the repository:
+```sh
+git clone https://github.com/your-username/polychain.git
+   cd polychain
+```
+
+### Install dependencies:
+```sh
+npm install
+```
+
+### Usage
+
+Compile smart contracts and deploy on a local blockchain:
+
+```sh
+truffle compile
+truffle migrate
+```
+- Start the server:
+```sh
+node server.js
+```
+
+- Run E2E tests:
+```sh
+npm run cypress
+```
+
+## Contributing
+
+Contributions are welcome! If you have any ideas or improvements, feel free to open an issue or a pull request.
+
+## License
+This project is licensed under the [MIT License](./LICENSE).