Skip to content

Commit a99dd19

Browse files
committed
docs: refresh architecture/deployment docs and reframe README messaging
1 parent f4e8250 commit a99dd19

10 files changed

Lines changed: 1402 additions & 1391 deletions

README.md

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# 🎓 Blockchain-Based Verifiable Credential System for Academic Transcripts
1+
# 🎓 Blockchain-Based Verifiable Credential System for Academic Transcripts
22

3-
**Version 2.1.0** | An elite decentralized, privacy-preserving platform for issuing, storing, and verifying academic credentials using Private Blockchain technology and advanced cryptography.
3+
**Version 2.2.0** | A custom private-blockchain credential system for issuing, storing, and verifying academic records with IPFS-integrated storage and cryptographic validation.
44

55
[![Docker Pulls](https://img.shields.io/docker/pulls/udaycodespace/credify?style=flat-square&logo=docker)](https://hub.docker.com/r/udaycodespace/credify)
66
[![Docker Image Size](https://img.shields.io/docker/image-size/udaycodespace/credify?style=flat-square&logo=docker)](https://hub.docker.com/r/udaycodespace/credify)
@@ -26,30 +26,30 @@
2626

2727
## 📌 Overview
2828

29-
Academic credential verification faces significant challenges in traditional systems: centralized control, slow processing times, susceptibility to forgery, and minimal privacy protection for students. This project addresses these critical issues by introducing a **trustless, tamper-proof, and privacy-first credential verification ecosystem**.
29+
Academic credential verification faces significant challenges in traditional systems: centralized control, slow processing times, susceptibility to forgery, and minimal privacy protection for students. This project addresses these issues with a **practical, tamper-evident, privacy-aware credential verification workflow**.
3030

31-
Our system leverages **Blockchain Technology, IPFS Distributed Storage, Advanced Cryptography, and W3C Verifiable Credential Standards** to create a robust platform where:
31+
Our system leverages **a custom private blockchain layer, IPFS-integrated storage, RSA signatures, and W3C-inspired credential modeling** to create a robust platform where:
3232

3333
- 🏛️ **Universities** issue cryptographically signed, tamper-proof digital credentials
3434
- 👨‍🎓 **Students** maintain complete ownership and control over their academic data
35-
- 💼 **Employers** verify credentials instantly with cryptographic proof, without third-party involvement
35+
- 💼 **Employers** verify credentials quickly with cryptographic integrity checks and signed metadata
3636
- 🔒 **Privacy** is preserved through selective disclosure mechanisms
3737
- 🎓 **Elite Presentation** Professional institutional-grade certificate viewer and 10/10 PDF generator
3838

39-
**Current Status:** Production-ready with comprehensive test coverage, premium UI/UX, and Multi-Node P2P Sync (Updated March 2026)
39+
**Current Status:** Refactored architecture with blueprints/services, end-to-end credential workflows, and active security hardening (Updated March 2026)
4040

4141
***
4242

4343
## 🚀 Quick Start
4444

45-
### 🐳 Docker Deployment: 3-Node Cluster (Recommended)
45+
### 🐳 Docker Deployment: 3-Node Simulation (Recommended)
4646

4747
```bash
4848
# Clone the repository
4949
git clone https://github.com/udaycodespace/credify.git
5050
cd credify
5151

52-
# Launch the decentralized 3-node P2P cluster
52+
# Launch the custom 3-node private blockchain cluster
5353
docker-compose up -d
5454

5555
# Access the isolated nodes
@@ -124,7 +124,7 @@ python main.py
124124

125125
### 🗄️ Distributed Storage
126126

127-
- IPFS integration for decentralized credential storage
127+
- IPFS integration with resilient local fallback storage
128128
- Content-addressed storage (CID-based retrieval)
129129
- Automatic fallback to local encrypted storage
130130
- Redundant data availability
@@ -174,10 +174,10 @@ python main.py
174174

175175
### Backend Architecture
176176

177-
- **Framework:** Python 3.10+ with Flask 3.0
178-
- **Database:** SQLite (Development) / PostgreSQL (Production-ready)
177+
- **Framework:** Python 3.10+ with Flask 2.x
178+
- **Data Layer:** Hybrid persistence for credential, registry, and blockchain state
179179
- **ORM:** SQLAlchemy with Flask-SQLAlchemy
180-
- **Authentication:** Flask-Login with secure session management
180+
- **Authentication:** Session-based auth with role guards and MFA setup flow
181181
- **Security:** Werkzeug password hashing, CSRF protection
182182
- **PDF Engine:** ReportLab for high-fidelity academic document generation
183183

@@ -202,7 +202,7 @@ python main.py
202202
- **CI/CD:** GitHub Actions automated workflows
203203
- **Registry:** Docker Hub for image distribution
204204
- **Hosting:** Render cloud platform
205-
- **Testing:** pytest with 60% coverage
205+
- **Testing:** pytest (58 tests across 14 test files)
206206
- **Code Quality:** Black, Flake8, isort
207207
- **Monitoring:** Health checks and logging
208208

@@ -532,12 +532,12 @@ pytest tests/test_blockchain.py -v
532532

533533
### Current Statistics (v2.0)
534534

535-
- **Credentials Issued:** Production-ready
535+
- **Credentials Issued:** Active demo dataset
536536
- **Verification Time:** < 2 seconds average
537537
- **Blockchain Blocks:** Dynamic growth
538538
- **Storage Efficiency:** 95% (IPFS CID deduplication)
539539
- **Uptime:** 99.9% target
540-
- **Test Success Rate:** 98.3% (57/58 tests)
540+
- **Test Coverage Status:** 58 tests across 14 files
541541

542542
### Performance Benchmarks
543543

@@ -625,15 +625,15 @@ pytest tests/test_blockchain.py -v
625625

626626
### Core Development Team
627627

628-
#### Backend & Blockchain Architecture
628+
#### Lead Architect, Backend & Blockchain Engineering
629629
**[@udaycodespace](https://github.com/udaycodespace)** - [Somapuram Uday](https://www.linkedin.com/in/somapuram-uday/)
630-
- Design and implementation of blockchain consensus mechanism
630+
- End-to-end system architecture ownership and technical direction
631+
- Design and implementation of blockchain simulation and consensus flow
631632
- Cryptographic protocol development and security architecture
632-
- Smart contract logic and credential lifecycle management
633-
- Database architecture and ORM implementation
634-
- RESTful API development and integration
635-
- DevOps pipeline setup and production deployment
636-
- System optimization and performance tuning
633+
- Credential lifecycle and verification workflow orchestration
634+
- Backend modularization (blueprints + service layer refactor)
635+
- DevOps pipeline setup, container strategy, and deployment integration
636+
- Performance tuning and platform stabilization
637637

638638
#### Frontend & User Experience
639639
**[@shashikiran47](https://github.com/shashikiran47)** - [Shashi Kiran](https://www.linkedin.com/in/sashi-kiran-02bb8a255/)
@@ -659,7 +659,7 @@ pytest tests/test_blockchain.py -v
659659

660660
| Developer | Primary Focus | Key Contributions |
661661
|:----------|:-------------|:------------------|
662-
| **[@udaycodespace](https://github.com/udaycodespace)** | Backend & Infrastructure | Blockchain, Cryptography, CI/CD, DevOps |
662+
| **[@udaycodespace](https://github.com/udaycodespace)** | Lead Architect & Core Platform Owner | Architecture, Blockchain, Cryptography, Backend, CI/CD, DevOps |
663663
| **[@shashikiran47](https://github.com/shashikiran47)** | Frontend & Design | Senior UI/UX, IPFS Integration, User Experience |
664664
| **[@tejavarshith](https://github.com/tejavarshith)** | Testing & Documentation | Test Suite, QA, Technical Documentation |
665665

@@ -668,14 +668,14 @@ pytest tests/test_blockchain.py -v
668668
🎯 **Team Milestones:**
669669

670670
- ✅ 100% test coverage on critical security paths
671-
-Production-ready deployment achieved
671+
-Deployment-ready architecture achieved
672672
- ✅ Comprehensive documentation suite completed
673673
- ✅ Zero critical security vulnerabilities
674674
- ✅ Docker containerization implemented
675675
- ✅ CI/CD pipeline with automated testing and deployment
676676
- ✅ Docker Hub integration for image distribution
677677

678-
**All team members contributed equally to the successful completion of this project.**
678+
**Core platform architecture and implementation were led by Uday, with frontend and QA/documentation collaboration support from the team.**
679679

680680
***
681681

@@ -823,7 +823,7 @@ Our solution provides:
823823

824824
- ✅ Instant verification (< 2 seconds)
825825
- ✅ Cost-effective (automated cryptographic process)
826-
-Decentralized (distributed blockchain and IPFS storage)
826+
-Tamper-evident (custom private blockchain + signed records + IPFS-integrated storage)
827827
- ✅ Privacy-preserving (selective disclosure with zero-knowledge proofs)
828828

829829
**Impact:** Transforming academic credential verification for the digital age, empowering students with data ownership while providing institutions and employers with trustworthy, instant verification.
@@ -888,3 +888,5 @@ See `docs/DEPLOYMENT.md` for detailed deployment instructions for various platfo
888888
>
889889
> **Current Edited Date:** `2026-03-08 19:50:00 IST`
890890
891+
892+

docs/API_REFERENCE.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# 📟 Credify API Reference
1+
# Credify API Reference
22

33
This document provides detailed information about the endpoints available in the Credify system.
44

5-
## 🔑 Base URL
5+
## Base URL
66
`http://localhost:5000` (Local)
77
`https://credify-2026.onrender.com` (Production)
88

99
---
1010

11-
## 🏛️ Ledger Endpoints
11+
## Ledger Endpoints
1212

1313
### 1. View Blockchain
1414
- **URL:** `/api/blockchain`
@@ -25,11 +25,11 @@ This document provides detailed information about the endpoints available in the
2525
- **Body:**
2626
```json
2727
{
28-
"student_name": "UDAY",
29-
"roll_number": "229X1A0XXX",
30-
"program": "B.Tech CSE",
31-
"semester": "8th",
32-
"gpa": "9.8"
28+
"student_name": "UDAY",
29+
"roll_number": "229X1A0XXX",
30+
"program": "B.Tech CSE",
31+
"semester": "8th",
32+
"gpa": "9.8"
3333
}
3434
```
3535
- **Security:** Requires Admin session.
@@ -43,7 +43,7 @@ This document provides detailed information about the endpoints available in the
4343

4444
---
4545

46-
## 🔒 Authentication
46+
## Authentication
4747

4848
### Login
4949
- **URL:** `/auth/login`
@@ -52,7 +52,7 @@ This document provides detailed information about the endpoints available in the
5252

5353
---
5454

55-
## 📦 Storage (IPFS)
55+
## Storage (IPFS)
5656

5757
### Upload to IPFS
5858
- **URL:** `/api/ipfs_upload`
@@ -65,6 +65,7 @@ This document provides detailed information about the endpoints available in the
6565
> Use the **Tutorial** page for visual walkthroughs of these endpoints.
6666
6767
***
68-
**Developed by:** SHASHI UDAY VARSHITH
68+
**Developed by:** SHASHI UDAY VARSHITH
6969
**Guidance:** Dr. B. Thimma Reddy Sir, Dr. G. Rajeswarappa Sir and Shri Shri K Bala Chowdappa Sir
7070
**Dated:** 2026-03-08
71+

0 commit comments

Comments
 (0)