Skip to content

Y33t-dev/pagpay

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Tokenized Community Credit Union (TCCU)

A community-governed financial cooperative platform built on the Stellar blockchain using Soroban smart contracts.

TCCU gives communities the tools to create savings groups, rotating savings clubs, cooperative loan pools, member treasuries, and emergency funds — all managed transparently on-chain.

This repository contains the open-source foundation. It is designed to be extended by contributors.


What Is This

TCCU is a set of smart contracts, a backend API, and a frontend interface that lets communities:

  • Create and manage financial cooperatives on Stellar
  • Register members and assign roles
  • Pool savings together in shared vaults
  • Manage a cooperative treasury
  • (Future) Issue and repay loans
  • (Future) Vote on financial decisions
  • (Future) Run rotating savings groups (chama / susu style)

Project Structure

tccu/
├── contracts/          # Soroban smart contracts (Rust)
│   ├── cooperative/    # Cooperative creation and management
│   ├── member/         # Member registration and roles
│   ├── savings_pool/   # Savings pool structure
│   └── treasury/       # Treasury management
├── backend/            # Rust REST API (Axum)
│   └── src/
│       ├── routes/     # Route definitions
│       ├── handlers/   # Request handlers
│       ├── models/     # Data models
│       └── contract_layer/ # Stellar/Soroban interaction
├── frontend/           # Static HTML/CSS/JS frontend shell
│   ├── pages/          # Individual page files
│   ├── styles/         # CSS
│   └── js/             # JavaScript
└── docs/               # Additional documentation

Requirements

To work with the smart contracts:

To work with the backend:

  • Rust (same as above)
  • Cargo

To work with the frontend:

  • Any web browser
  • A local HTTP server (e.g. python3 -m http.server)

Quick Start

1. Clone the repo

git clone https://github.com/your-org/tccu.git
cd tccu

2. Build the smart contracts

cd contracts
cargo build --release --target wasm32-unknown-unknown

3. Deploy to Stellar testnet

stellar contract deploy \
  --wasm target/wasm32-unknown-unknown/release/cooperative.wasm \
  --source YOUR_SECRET_KEY \
  --network testnet

4. Run the backend

cd backend
cargo run

The API will start at http://localhost:3000.

5. Open the frontend

cd frontend
python3 -m http.server 8080

Open http://localhost:8080 in your browser.


Documentation

File Purpose
PRD.md Product requirements and vision
ARCHITECTURE.md Technical architecture overview
ROADMAP.md Development roadmap and milestones
CONTRIBUTING.md How to contribute
SECURITY.md Security policy

Status

This is the foundation release. The core contracts, backend structure, and frontend shell are in place. The project is ready for contributors to extend.

See ROADMAP.md for what is planned and CONTRIBUTING.md for how to get involved.


License

Apache 2.0. See LICENSE.

About

No description, website, or topics provided.

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages