Cardano Payroll

Cardano Payroll is a full-stack payroll platform for paying employees in ADA.

It combines:

• a Spring Boot backend for employee management, payroll processing, and blockchain integrations
• a Next.js frontend for operations and wallet-driven payments
• PostgreSQL for persistence

Why This Project

• Pay employees on Cardano with auditable transaction history
• Manage payroll records and employee wallet addresses in one system
• Support browser-wallet initiated payroll with backend-controlled network and Kuber configuration

Tech Stack

• Backend: Java 17, Spring Boot, Maven
• Frontend: Next.js, React, TypeScript
• Database: PostgreSQL
• Integrations: Blockfrost, Kuber API
• Deployment: Docker Compose + GitHub Actions

Quick Start (Docker)

1. Clone the repository.

git clone https://github.com/cardanoapi/cardano-payroll.git
cd cardano-payroll

2. Create .env from .env.example and set required values.

cp .env.example .env

3. Build and run.

docker compose up --build -d

4. Open services.

• Frontend: http://localhost:3000
• Backend: http://localhost:8080
• Health: http://localhost:8080/actuator/health

Run Locally (Without Docker)

Backend:

cd cardano-payroll
./mvnw spring-boot:run

Frontend:

cd cardano-payroll-frontend
npm ci
npm run dev

GHCR Images

This repo publishes container images to GHCR for the remote github.com/cardanoapi/cardano-payroll:

• ghcr.io/cardanoapi/cardano-payroll-backend
• ghcr.io/cardanoapi/cardano-payroll-frontend

Example pull:

docker pull ghcr.io/cardanoapi/cardano-payroll-backend:latest
docker pull ghcr.io/cardanoapi/cardano-payroll-frontend:latest

Documentation Split

• Product/usage overview: this file (README.md)
• Developer deep dive and detailed technical docs: DEVELOPER.md