Skip to content

Commit dc8182d

Browse files
committed
Update README with latest project changes
1 parent 2151290 commit dc8182d

1 file changed

Lines changed: 42 additions & 27 deletions

File tree

README.md

Lines changed: 42 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,36 @@
1-
# Credify v2: Permissioned Private Blockchain for Academic Credential Verification
1+
2+
# Credify v2: Permissioned Private Blockchain for Academic Credential Verification
3+
4+
[![Docker Pulls](https://img.shields.io/docker/pulls/udaycodespace/credify?style=flat-square)](https://hub.docker.com/r/udaycodespace/credify)
5+
[![GitHub stars](https://img.shields.io/github/stars/udaycodespace/credify?style=flat-square)](https://github.com/udaycodespace/credify)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
7+
8+
<p align="center">
9+
<img src="https://img.shields.io/badge/Python-3.10+-blue?logo=python&logoColor=white&style=flat-square" alt="Python">
10+
<img src="https://img.shields.io/badge/Flask-2.x-lightgrey?logo=flask&logoColor=black&style=flat-square" alt="Flask">
11+
<img src="https://img.shields.io/badge/IPFS-Storage-blueviolet?logo=ipfs&logoColor=white&style=flat-square" alt="IPFS">
12+
<img src="https://img.shields.io/badge/Docker-Containerization-blue?logo=docker&logoColor=white&style=flat-square" alt="Docker">
13+
</p>
214

315
A permissioned private blockchain implementing deterministic consensus, validator-based participation, and finalized tamper-evident blocks for credential verification.
416

517
---
618

19+
## 🚀 Quick Start (Docker)
20+
21+
Run the latest release instantly using Docker:
22+
23+
```bash
24+
docker pull udaycodespace/credify:latest
25+
docker run -d -p 5000:5000 udaycodespace/credify:latest
26+
```
27+
28+
Then open [http://localhost:5000](http://localhost:5000) in your browser.
29+
30+
See the image and more details on [Docker Hub](https://hub.docker.com/r/udaycodespace/credify).
31+
32+
---
33+
734
## Security Notice
835

936
This is an academic engineering project built for educational evaluation and portfolio demonstration.
@@ -187,28 +214,14 @@ Application endpoint:
187214

188215
---
189216

190-
## Tech Stack
191-
192-
Backend and Core:
193-
- Python 3.10+
194-
- Flask
195-
- SQLAlchemy
196-
- Cryptography (RSA, SHA-256)
197-
198-
Blockchain and Storage:
199-
- permissioned private blockchain engine
200-
- deterministic validator consensus
201-
- IPFS integration with local fallback
202217

203-
Frontend and UX:
204-
- HTML/CSS/JavaScript
205-
- Jinja2 templates
206-
- responsive role-based dashboards
218+
## 🛠️ Tech Stack
207219

208-
Quality and Delivery:
209-
- pytest
210-
- Docker and docker-compose
211-
- GitHub Actions CI/CD
220+
- **Backend:** Python 3.10+, Flask, SQLAlchemy, Cryptography (RSA, SHA-256)
221+
- **Blockchain:** Custom permissioned private blockchain engine, deterministic validator consensus
222+
- **Storage:** IPFS integration with local fallback, SQLite/PostgreSQL
223+
- **Frontend:** HTML/CSS/JavaScript, Jinja2 templates, responsive dashboards
224+
- **DevOps:** Docker, docker-compose, GitHub Actions CI/CD
212225

213226
---
214227

@@ -286,17 +299,19 @@ Coverage focus:
286299

287300
---
288301

289-
## DevOps
290302

291-
CI/CD and containerization:
303+
---
304+
305+
## 📦 Docker & DevOps
306+
292307
- GitHub Actions for test/build/publish automation
293308
- Docker multi-stage builds
294-
- Docker image publishing to Docker Hub
295-
- validator-cluster orchestration via docker-compose
309+
- Docker image published to [Docker Hub](https://hub.docker.com/r/udaycodespace/credify)
310+
- Validator-cluster orchestration via docker-compose
296311

297312
Deployment posture:
298-
- deployment-ready for academic demos and controlled environments
299-
- configurable environment variables for node identity and peers
313+
- Ready for academic demos and controlled environments
314+
- Configurable environment variables for node identity and peers
300315

301316
---
302317

0 commit comments

Comments
 (0)