|
1 | | -# Credify v2: Permissioned Private Blockchain for Academic Credential Verification |
| 1 | + |
| 2 | +# Credify v2: Permissioned Private Blockchain for Academic Credential Verification |
| 3 | + |
| 4 | +[](https://hub.docker.com/r/udaycodespace/credify) |
| 5 | +[](https://github.com/udaycodespace/credify) |
| 6 | +[](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> |
2 | 14 |
|
3 | 15 | A permissioned private blockchain implementing deterministic consensus, validator-based participation, and finalized tamper-evident blocks for credential verification. |
4 | 16 |
|
5 | 17 | --- |
6 | 18 |
|
| 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 | + |
7 | 34 | ## Security Notice |
8 | 35 |
|
9 | 36 | This is an academic engineering project built for educational evaluation and portfolio demonstration. |
@@ -187,28 +214,14 @@ Application endpoint: |
187 | 214 |
|
188 | 215 | --- |
189 | 216 |
|
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 |
202 | 217 |
|
203 | | -Frontend and UX: |
204 | | -- HTML/CSS/JavaScript |
205 | | -- Jinja2 templates |
206 | | -- responsive role-based dashboards |
| 218 | +## 🛠️ Tech Stack |
207 | 219 |
|
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 |
212 | 225 |
|
213 | 226 | --- |
214 | 227 |
|
@@ -286,17 +299,19 @@ Coverage focus: |
286 | 299 |
|
287 | 300 | --- |
288 | 301 |
|
289 | | -## DevOps |
290 | 302 |
|
291 | | -CI/CD and containerization: |
| 303 | +--- |
| 304 | + |
| 305 | +## 📦 Docker & DevOps |
| 306 | + |
292 | 307 | - GitHub Actions for test/build/publish automation |
293 | 308 | - 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 |
296 | 311 |
|
297 | 312 | 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 |
300 | 315 |
|
301 | 316 | --- |
302 | 317 |
|
|
0 commit comments