From f37af321296a234f4dd53ca31ee7135cd3e19ce4 Mon Sep 17 00:00:00 2001 From: "anjanakri.work@gmail.com" Date: Tue, 26 May 2026 13:06:30 +0530 Subject: [PATCH 1/5] docs: added formatted README with screenshots and improved structure --- README.md | 291 +++++++++++++++++++++++++++--------------------------- 1 file changed, 147 insertions(+), 144 deletions(-) diff --git a/README.md b/README.md index f727407..69e9f9a 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,41 @@ -🧬 OrganChain +# OrganChain -A decentralized healthcare platform designed to ensure **secure, transparent, and tamper-proof management of organ donation and medical data** using blockchain, IPFS, and cloud technologies. +A decentralized healthcare platform for **secure, transparent, and tamper-proof management of organ donation and medical data** — built on blockchain, IPFS, and cloud technologies. +--- + +## Table of Contents + +- [Project Description](#project-description) +- [Architecture Overview](#architecture-overview) +- [Project Structure](#project-structure) +- [Tech Stack](#tech-stack) +- [Detailed Workflow](#detailed-workflow) +- [Key Features](#key-features) +- [Setup Instructions](#setup-instructions) +- [Deployment](#deployment) +- [Comparison with Traditional Systems](#comparison-with-traditional-systems) +- [Limitations](#limitations) +- [Future Scope](#future-scope) +- [Contributing](#contributing) + +--- - Project Description +## Project Description -OrganChain addresses critical challenges in traditional healthcare systems such as: +OrganChain addresses critical challenges in traditional healthcare systems: -* Data tampering -* Lack of transparency in organ allocation -* Centralized control of sensitive records +- Data tampering +- Lack of transparency in organ allocation +- Centralized control of sensitive records -By integrating "Web3 technologies", the system ensures trust, traceability, and decentralization. +By integrating Web3 technologies, the system ensures trust, traceability, and decentralization across all medical data interactions. +--- - >> Architecture Overview +## Architecture Overview - -> End-to-End Flow +### End-to-End Flow ``` User → Frontend (React - Vercel) @@ -26,151 +45,132 @@ User → Frontend (React - Vercel) File Upload → Backend → Pinata → IPFS → CID stored on Blockchain ``` + +--- + ## Project Structure ``` organchain/ │ -├── frontend/ # React frontend -├── backend/ # Spring Boot application -├── contracts/ # Solidity smart contracts -├── scripts/ # Deployment scripts -├── config/ # Environment configurations +├── frontend/ # React frontend +├── backend/ # Spring Boot application +├── contracts/ # Solidity smart contracts +├── scripts/ # Deployment scripts +├── config/ # Environment configurations └── README.md ``` ->> Tech Stack (With Purpose) - - ## Frontend - -* React.js -* Vercel (Deployment) - -Why? >> - -* Fast UI rendering -* Seamless Web3 integration -* Serverless and scalable hosting ->> Backend - -* Spring Boot -* Maven - -**Why Spring Boot?** - -* Handles complex business logic -* Enterprise-grade architecture -* Secure REST APIs - -**Why Maven?** - -* Dependency management -* Build automation - - ->> Blockchain - -* Ethereum Smart Contracts -* Alchemy API - -**Why?** +--- -* Immutable data storage -* Decentralized trust -* No need for self-hosted nodes +## Tech Stack ---- +### Frontend ->> Storage +| Technology | Purpose | +|------------|---------| +| React.js | Fast UI rendering and seamless Web3 integration | +| Vercel | Serverless, scalable hosting | -* IPFS -* Pinata +### Backend -**Why?** +| Technology | Purpose | +|------------|---------| +| Spring Boot | Complex business logic, enterprise-grade REST APIs | +| Maven | Dependency management and build automation | -* Decentralized file storage -* Content-based addressing -* Reliable pinning service +### Blockchain ---- +| Technology | Purpose | +|------------|---------| +| Ethereum Smart Contracts | Immutable, decentralized data storage | +| Alchemy API | Managed node access — no self-hosted infrastructure needed | ->> Development Tools +### Storage -* Ganache (Local blockchain) -* ngrok (Public tunnel) +| Technology | Purpose | +|------------|---------| +| IPFS | Decentralized, content-addressed file storage | +| Pinata | Reliable IPFS pinning service | -**Why?** +### Development Tools -* Faster local testing -* Easy frontend-backend integration +| Tool | Purpose | +|------|---------| +| Ganache | Local blockchain for faster testing | +| ngrok | Public tunnel for easy frontend-backend integration | --- ## Detailed Workflow -### User Interaction - -* User accesses the web app -* Inputs data or uploads medical records - -### Backend Processing - -* Validates user data -* Prepares blockchain transactions - -### File Upload (IPFS) - -* File sent to Pinata -* IPFS returns a unique **CID (Content Identifier)** +### 1. User Interaction +- User accesses the web app +- Inputs data or uploads medical records -### Blockchain Storage +### 2. Backend Processing +- Validates user data +- Prepares blockchain transactions -* Smart contract stores: +### 3. File Upload (IPFS) +- File is sent to Pinata +- IPFS returns a unique **CID (Content Identifier)** - * Metadata - * IPFS CID +### 4. Blockchain Storage +- Smart contract stores metadata and the IPFS CID -### Data Retrieval - -* Fetch CID from blockchain -* Retrieve file from IPFS securely +### 5. Data Retrieval +- CID is fetched from the blockchain +- File is retrieved securely from IPFS --- - +## Screenshots + +### Homepage +*Public-facing landing page with organ donation awareness and pledge CTA* + +![OrganChain Homepage](Desktop/organchain-main/organchain-main/Version_1_Frontend/src/screenshots/landing-page.png) + +--- + +### Admin Dashboard +*Platform dashboard for managing donors, patients, pledges, and transplant matching* + +![OrganChain Dashboard](Desktop\organchain-main\organchain-main\Version_1_Frontend\src\screenshots\dashboard.png) +--- ## Key Features - -* Tamper-proof records using blockchain -* Decentralized storage via IPFS -* Transparent organ tracking system -* Secure API-based backend -* Local blockchain testing environment +- Tamper-proof records using blockchain +- Decentralized file storage via IPFS +- Transparent organ tracking system +- Secure API-based backend +- Local blockchain testing environment --- - >> Setup Instructions - -🔹 Prerequisites +## Setup Instructions +### Prerequisites -* Node.js -* Java (JDK 8+) -* Maven -* Ganache -* MetaMask Extension - -🔹 Clone the Repository +- Node.js +- Java (JDK 8+) +- Maven +- Ganache +- MetaMask browser extension +### Clone the Repository ```bash -git clone https://github.com/ffrazi/organchain.git -cd organchain +git clone https://github.com/jaideep005/Organ_BlockChain.git +cd Organ_BlockChain ``` -🔹 Backend Setup + +### Backend Setup ```bash cd backend mvn clean install mvn spring-boot:run ``` -🔹 Frontend Setup + +### Frontend Setup ```bash cd frontend @@ -178,58 +178,61 @@ npm install npm start ``` -🔹 Smart Contract Deployment +### Smart Contract Deployment ```bash cd contracts -# compile & deploy using truffle/hardhat +# Compile and deploy using Truffle or Hardhat ``` -🔹 Start Ganache - -* Launch Ganache GUI or CLI -* Copy RPC URL and configure in project +### Start Ganache +1. Launch Ganache (GUI or CLI) +2. Copy the RPC URL +3. Configure the RPC URL in the project's environment settings --- - ->> Deployment +## Deployment | Component | Platform | -| ---------- | -------------------- | +|------------|----------------------| | Frontend | Vercel | -| Backend | Cloud (AWS/Heroku) | +| Backend | Cloud (AWS / Heroku) | | Blockchain | Ethereum via Alchemy | | Storage | IPFS via Pinata | +--- ->> Comparison with Traditional Systems - -| Feature | Traditional System | OrganChain | -| ------------ | ------------------ | ----------------- | -| Storage | Centralized DB | IPFS | -| Trust | Low | High (Blockchain) | -| Transparency | Limited | Full | -| Security | Moderate | High | +## Comparison with Traditional Systems +| Feature | Traditional System | OrganChain | +|----------------|--------------------|-------------------| +| Storage | Centralized DB | IPFS | +| Trust | Low | High (Blockchain) | +| Transparency | Limited | Full | +| Security | Moderate | High | ->> Limitations +--- -* Gas fees for blockchain transactions -* Slower write operations -* Requires Web3 knowledge +## Limitations +- Gas fees apply for blockchain transactions +- Write operations are slower than traditional databases +- Requires Web3 knowledge for setup and interaction ->> Future Scope +--- -* AI-based organ matching system -* Real-time dashboards -* Integration with hospital APIs -* Multi-chain compatibility +## Future Scope +- AI-based organ matching system +- Real-time dashboards +- Integration with hospital APIs +- Multi-chain compatibility ->> Contributing +--- +## Contributing 1. Fork the repository -2. Create a new branch -3. Commit your changes -4. Push and create PR +2. Create a new branch (`git checkout -b feature/your-feature`) +3. Commit your changes (`git commit -m 'Add your feature'`) +4. Push to your branch (`git push origin feature/your-feature`) +5. Open a Pull Request -## ⭐ Acknowledgement +--- -If you find this project useful, consider giving it a ⭐ on GitHub! +> If you find this project useful, consider giving it a ⭐ on GitHub! From 2190a9a76e7d64c6a272d07c2cbe1157390fc29c Mon Sep 17 00:00:00 2001 From: Anjana Kumari <177652279+anjanakri@users.noreply.github.com> Date: Tue, 26 May 2026 13:18:01 +0530 Subject: [PATCH 2/5] Fix image path format in README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 69e9f9a..ee0303c 100644 --- a/README.md +++ b/README.md @@ -136,7 +136,7 @@ organchain/ ### Admin Dashboard *Platform dashboard for managing donors, patients, pledges, and transplant matching* -![OrganChain Dashboard](Desktop\organchain-main\organchain-main\Version_1_Frontend\src\screenshots\dashboard.png) +![OrganChain Dashboard](Desktop/organchain-main/organchain-main/Version_1_Frontend/src/screenshots/dashboard.png) --- ## Key Features - Tamper-proof records using blockchain From 92b8b2301b939860d6f75b86da472ba173711e4c Mon Sep 17 00:00:00 2001 From: Anjana Kumari <177652279+anjanakri@users.noreply.github.com> Date: Tue, 26 May 2026 22:36:35 +0530 Subject: [PATCH 3/5] Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ee0303c..f2594e8 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ File Upload → Backend → Pinata → IPFS → CID stored on Blockchain ## Project Structure ``` -organchain/ +Organ_BlockChain/ │ ├── frontend/ # React frontend ├── backend/ # Spring Boot application From 636ac95da248d8cd05916f48c418b68e8003fd41 Mon Sep 17 00:00:00 2001 From: Anjana Kumari <177652279+anjanakri@users.noreply.github.com> Date: Wed, 27 May 2026 21:26:37 +0530 Subject: [PATCH 4/5] Revise README for clarity and additional details Updated language for clarity and consistency throughout the README. Added sections on project features, setup instructions, and future scope. --- README.md | 243 +++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 178 insertions(+), 65 deletions(-) diff --git a/README.md b/README.md index f2594e8..179de37 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # OrganChain -A decentralized healthcare platform for **secure, transparent, and tamper-proof management of organ donation and medical data** — built on blockchain, IPFS, and cloud technologies. +A decentralized healthcare platform for **secure, transparent, and tamper-proof management of organ donation and medical data** — built using blockchain, IPFS, and cloud technologies. --- @@ -11,6 +11,7 @@ A decentralized healthcare platform for **secure, transparent, and tamper-proof - [Project Structure](#project-structure) - [Tech Stack](#tech-stack) - [Detailed Workflow](#detailed-workflow) +- [Screenshots](#screenshots) - [Key Features](#key-features) - [Setup Instructions](#setup-instructions) - [Deployment](#deployment) @@ -23,22 +24,29 @@ A decentralized healthcare platform for **secure, transparent, and tamper-proof ## Project Description -OrganChain addresses critical challenges in traditional healthcare systems: +OrganChain addresses major challenges in traditional healthcare systems such as: - Data tampering - Lack of transparency in organ allocation -- Centralized control of sensitive records +- Centralized control of sensitive medical records -By integrating Web3 technologies, the system ensures trust, traceability, and decentralization across all medical data interactions. +By integrating Web3 technologies, the platform ensures: + +- Trust +- Transparency +- Traceability +- Decentralization + +across all healthcare data interactions. --- ## Architecture Overview -### End-to-End Flow +### End-to-End Workflow -``` -User → Frontend (React - Vercel) +```text +User → Frontend (React + Vercel) → Backend (Spring Boot REST APIs) → Blockchain (Ethereum via Alchemy) → Smart Contracts @@ -50,11 +58,11 @@ File Upload → Backend → Pinata → IPFS → CID stored on Blockchain ## Project Structure -``` +```text Organ_BlockChain/ │ -├── frontend/ # React frontend -├── backend/ # Spring Boot application +├── frontend/ # React frontend application +├── backend/ # Spring Boot backend services ├── contracts/ # Solidity smart contracts ├── scripts/ # Deployment scripts ├── config/ # Environment configurations @@ -69,99 +77,126 @@ Organ_BlockChain/ | Technology | Purpose | |------------|---------| -| React.js | Fast UI rendering and seamless Web3 integration | -| Vercel | Serverless, scalable hosting | +| React.js | Fast and responsive user interface | +| Vercel | Scalable frontend hosting | + +--- ### Backend | Technology | Purpose | |------------|---------| -| Spring Boot | Complex business logic, enterprise-grade REST APIs | +| Spring Boot | REST APIs and backend business logic | | Maven | Dependency management and build automation | +--- + ### Blockchain | Technology | Purpose | |------------|---------| -| Ethereum Smart Contracts | Immutable, decentralized data storage | -| Alchemy API | Managed node access — no self-hosted infrastructure needed | +| Ethereum Smart Contracts | Immutable decentralized storage | +| Alchemy API | Blockchain node infrastructure | + +--- ### Storage | Technology | Purpose | |------------|---------| -| IPFS | Decentralized, content-addressed file storage | +| IPFS | Decentralized file storage | | Pinata | Reliable IPFS pinning service | +--- + ### Development Tools | Tool | Purpose | |------|---------| -| Ganache | Local blockchain for faster testing | -| ngrok | Public tunnel for easy frontend-backend integration | +| Ganache | Local Ethereum blockchain testing | +| MetaMask | Wallet integration and transaction signing | +| ngrok | Public tunnel for local backend exposure | --- ## Detailed Workflow ### 1. User Interaction -- User accesses the web app -- Inputs data or uploads medical records +- User accesses the web application +- Uploads medical records or enters donor/patient data ### 2. Backend Processing -- Validates user data +- Validates incoming data +- Handles API communication - Prepares blockchain transactions -### 3. File Upload (IPFS) -- File is sent to Pinata -- IPFS returns a unique **CID (Content Identifier)** +### 3. File Upload to IPFS +- Files are uploaded to Pinata +- IPFS generates a unique CID (Content Identifier) ### 4. Blockchain Storage -- Smart contract stores metadata and the IPFS CID +- Smart contracts store metadata and IPFS CID references +- Data becomes immutable and traceable -### 5. Data Retrieval +### 5. Secure Retrieval - CID is fetched from the blockchain -- File is retrieved securely from IPFS +- Files are securely retrieved from IPFS --- -## Screenshots - -### Homepage + +## Screenshots + +### Homepage *Public-facing landing page with organ donation awareness and pledge CTA* - + ![OrganChain Homepage](Desktop/organchain-main/organchain-main/Version_1_Frontend/src/screenshots/landing-page.png) - + --- - + ### Admin Dashboard -*Platform dashboard for managing donors, patients, pledges, and transplant matching* - +*Dashboard for managing donors, recipients, pledges, and transplant records* + ![OrganChain Dashboard](Desktop/organchain-main/organchain-main/Version_1_Frontend/src/screenshots/dashboard.png) + --- + ## Key Features -- Tamper-proof records using blockchain + +- Tamper-proof medical records using blockchain - Decentralized file storage via IPFS -- Transparent organ tracking system -- Secure API-based backend -- Local blockchain testing environment +- Transparent organ donor tracking system +- Smart contract-powered verification +- Secure REST API backend +- Local blockchain development environment +- Immutable audit trails for sensitive data --- ## Setup Instructions + ### Prerequisites +Install the following before starting: + - Node.js - Java (JDK 8+) - Maven - Ganache -- MetaMask browser extension +- MetaMask Browser Extension + +--- ### Clone the Repository + +By default, cloning this repository creates a local folder named `Organ_BlockChain`. + ```bash git clone https://github.com/jaideep005/Organ_BlockChain.git cd Organ_BlockChain ``` +--- + ### Backend Setup ```bash @@ -170,6 +205,10 @@ mvn clean install mvn spring-boot:run ``` +Backend server will start on the configured port. + +--- + ### Frontend Setup ```bash @@ -178,61 +217,135 @@ npm install npm start ``` +Frontend will run on: + +```text +http://localhost:3000 +``` + +--- + ### Smart Contract Deployment ```bash cd contracts -# Compile and deploy using Truffle or Hardhat + +# Compile contracts +truffle compile + +# Deploy contracts +truffle migrate ``` +You may also use Hardhat if preferred. + +--- + ### Start Ganache -1. Launch Ganache (GUI or CLI) +1. Launch Ganache GUI or CLI 2. Copy the RPC URL -3. Configure the RPC URL in the project's environment settings +3. Configure the RPC URL in environment variables +4. Import Ganache accounts into MetaMask + --- + +## Environment Variables + +Create a `.env` file where required. + +Example: + +```env +ALCHEMY_API_KEY=your_api_key +PINATA_API_KEY=your_pinata_key +PINATA_SECRET_API_KEY=your_secret_key +PRIVATE_KEY=your_wallet_private_key +``` + +--- + ## Deployment -| Component | Platform | -|------------|----------------------| -| Frontend | Vercel | -| Backend | Cloud (AWS / Heroku) | +| Component | Platform | +|-----------|----------| +| Frontend | Vercel | +| Backend | AWS / Heroku / Render | | Blockchain | Ethereum via Alchemy | -| Storage | IPFS via Pinata | +| Storage | IPFS via Pinata | + --- ## Comparison with Traditional Systems -| Feature | Traditional System | OrganChain | -|----------------|--------------------|-------------------| -| Storage | Centralized DB | IPFS | -| Trust | Low | High (Blockchain) | -| Transparency | Limited | Full | -| Security | Moderate | High | + +| Feature | Traditional System | OrganChain | +|---------|-------------------|------------| +| Storage | Centralized Database | IPFS | +| Transparency | Limited | High | +| Trust | Institution-based | Blockchain-based | +| Security | Moderate | High | +| Auditability | Difficult | Immutable | +| Data Ownership | Centralized | Decentralized | --- ## Limitations -- Gas fees apply for blockchain transactions -- Write operations are slower than traditional databases -- Requires Web3 knowledge for setup and interaction + +- Blockchain transactions involve gas fees +- Slower write speeds compared to traditional databases +- Requires Web3 familiarity for advanced configuration +- Smart contract upgrades can be complex --- ## Future Scope -- AI-based organ matching system -- Real-time dashboards -- Integration with hospital APIs -- Multi-chain compatibility + +- AI-powered organ matching algorithms +- Real-time healthcare analytics dashboards +- Multi-chain blockchain compatibility +- Integration with hospital management systems +- Mobile application support +- Role-based access control enhancements --- ## Contributing + +Contributions are welcome. + +### Steps to Contribute + 1. Fork the repository -2. Create a new branch (`git checkout -b feature/your-feature`) -3. Commit your changes (`git commit -m 'Add your feature'`) -4. Push to your branch (`git push origin feature/your-feature`) +2. Create a feature branch + +```bash +git checkout -b feature/your-feature +``` + +3. Commit your changes + +```bash +git commit -m "Add your feature" +``` + +4. Push your branch + +```bash +git push origin feature/your-feature +``` + 5. Open a Pull Request --- -> If you find this project useful, consider giving it a ⭐ on GitHub! +## License + +This project is licensed under the `MIT License`. + +--- + +## Support + +If you found this project useful, consider giving it a ⭐ on GitHub. + +--- From bf41626fc7a3d87cde2431ec6741510aff7c4759 Mon Sep 17 00:00:00 2001 From: Anjana Kumari <177652279+anjanakri@users.noreply.github.com> Date: Wed, 27 May 2026 21:34:17 +0530 Subject: [PATCH 5/5] Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 179de37..340e1a4 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# OrganChain +# Organ_BlockChain A decentralized healthcare platform for **secure, transparent, and tamper-proof management of organ donation and medical data** — built using blockchain, IPFS, and cloud technologies.