From c3a1b7eab1622eeddcb2953f53becbcdc34d87ba Mon Sep 17 00:00:00 2001 From: devzeeh <148837352+devzeeh@users.noreply.github.com> Date: Sun, 26 Apr 2026 15:34:09 +0800 Subject: [PATCH 1/2] docs: update project branding, feature list, and tech stack in README --- README.md | 39 ++++++++++++++++++--------------------- 1 file changed, 18 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 703ab13..5b42540 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,7 @@ # UniCard -> This is an Open Source of my personal project *[PayCard](https://github.com/devzeeh/PayCard)* - +![GitHub Release](https://img.shields.io/github/v/release/devzeeh/unicard) ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/devzeeh/unicard) -[![MySQL](https://img.shields.io/badge/MySQL-8.0-4479A1?style=flat&logo=mysql&logoColor=blue)](https://www.mysql.com/) ![Status](https://img.shields.io/badge/Status-Development-blue) ![GitHub Created At](https://img.shields.io/github/created-at/devzeeh/unicard) ![GitHub last commit](https://img.shields.io/github/last-commit/devzeeh/unicard) @@ -17,36 +15,35 @@ ## Overview -**PayCard** is a cashless payment solution designed for retail stores and transportation. Built with affordable hardware and accessible technology as a school project. +**Unicard** is a cashless payment solution designed for retail stores and transportation. Built with affordable hardware and accessible technology as a school project. > **Note:** This project is for educational purposes only and not intended for commercial use. -## Why PayCard? +## Why Unicard? - **Fast Contactless Payments** - Utilizes RFID (ESP32 + RC522) for quick, tap-to-pay functionality. -- **Affordable Hardware** - Built using low-cost, readily available components. - **Rewards & Discount Logic** - Includes a proof-of-concept for a 20% fare discounts (e.g., for PWD/Students). - **Unified System** - A single card system designed to handle both retail (itemized) and transport (fare) transactions. - **Analytics Dashboard** - A simple dashboard for viewing transaction history and user data. ## Features -- **Card Lifecycle Management** - Core functions to register, activate, load, and block RFID cards. -- **Dual Payment Logic** - Handles both itemized billing (for retail) and distance-based fare calculation (for transport). -- **Reward Points System** - A proof-of-concept for calculating 0.2% cashback points per transaction. -- **Email Receipts** - Automatically sends transaction details via SMTP (e.g., Gmail) after a payment. -- **Web Dashboard** - A simple web interface for users, merchants, and admins to review transaction logs. -- **Transaction Security** - Implements card-to-server authentication, balance verification, and basic audit logging. +- **Card Lifecycle Management** - Core functions to register, activate, load, and block UniCard. +- **Dual Payment Logic** - Handles both itemized billing (for retail) and distance-based fare calculation (for transport). (QR Code & RFID) +- **Reward Points System** - Calculates 0.2% cashback points per transaction. +- **Email Receipts** - Automatically sends transaction details to users registered email after a successful transaction. +- **Web Dashboard** - A simple web interface for users, merchants, and admins to review transaction logs, user data, and card details. +- **Transaction Security** - Ensures secure data transmission, robust session management, and OTP verification to protect user accounts and payment information. ## Tech Stack (MVP Stack) | Component | Technology | |-----------|-----------| -| **Backend** | Go 1.22+ | -| **Database** | MySQL 8.0+ | -| **Payments** | Stripe API | +| **Backend** | Go 1.25 | +| **Database** | MySQL | +| **Payments** | Stripe | | **Hardware** | ESP32 + RC522 RFID | | **Frontend** | HTML, Tailwind CSS, JavaScript | -| **Email** | SMTP (Gmail) | +| **Email** | SMTP | | **Version Control** | Git & GitHub | ## Quick Start @@ -55,17 +52,17 @@ A video demonstration will be available here once the project is finalized. ### Transaction Flow -``` -User taps card ➔ Validates balance ➔ Deducts payment ➔ Earns points ➔ Receipt sent +```mermaid +Tap Card -> Validate balance -> Deduct Payment -> Update Data -> Earn Rewards -> Send Receipt -> Update Balance. ``` ### Sample Fare Receipt -![Sample Fare Receipt](assets/images/Fare%20Receipt.png) +![Sample Fare Receipt](frontend/assets/images/Fare%20Receipt.png) ### Sample Retail Receipt -![Sample Retail Receipt](assets/images/Retail%20Receipt.png) +![Sample Retail Receipt](frontend/assets/images/Retail%20Receipt.png) ## Acknowledgements @@ -93,6 +90,6 @@ This project was made possible by the incredible work of the following communiti Copyright © 2025 devzeeh. All Rights Reserved.
-[Back to Top](#paycard) +[Back to Top](#UniCard) From 3c597c228a76c097b93eba32a81854b7f4f79cc3 Mon Sep 17 00:00:00 2001 From: devzeeh <148837352+devzeeh@users.noreply.github.com> Date: Sun, 26 Apr 2026 15:38:23 +0800 Subject: [PATCH 2/2] docs: fix capitalization and formatting in transaction flow diagram description --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5b42540..ea54e14 100644 --- a/README.md +++ b/README.md @@ -52,8 +52,8 @@ A video demonstration will be available here once the project is finalized. ### Transaction Flow -```mermaid -Tap Card -> Validate balance -> Deduct Payment -> Update Data -> Earn Rewards -> Send Receipt -> Update Balance. +``` +Tap Card -> Validate Balance -> Deduct Payment -> Update Data -> Earn Rewards -> Send Receipt -> Update Balance. ``` ### Sample Fare Receipt