PetJs/acbu-frontend

โ˜… 0Forks 0TypeScriptGitHub โ†—Compare

README

ACBU Fintech Application

A modern, mobile-first fintech application built with Next.js 16 and React 19, featuring a comprehensive suite of financial services built exclusively around the native ACBU (AFK) currency.

๐ŸŽฏ Quick Start

The application uses a 5-tab mobile navigation system for primary feature access:

โ”Œโ”€ Home       โ”€ Dashboard & overview
โ”œโ”€ Send       โ”€ P2P transfers, international, history
โ”œโ”€ Mint       โ”€ Create/redeem AFK currency
โ”œโ”€ Business   โ”€ SME, payroll, enterprise tools
โ””โ”€ Me         โ”€ Account, settings, security

๐Ÿ“ Directory Structure

app/
โ”œโ”€โ”€ page.tsx                 # Home dashboard
โ”œโ”€โ”€ send/
โ”‚   โ””โ”€โ”€ page.tsx            # P2P transfers (main)
โ”‚   โ””โ”€โ”€ international/      # International transfers
โ”‚   โ””โ”€โ”€ history/            # Transfer history
โ”œโ”€โ”€ mint/
โ”‚   โ””โ”€โ”€ page.tsx            # Mint/Burn hub
โ”œโ”€โ”€ business/
โ”‚   โ”œโ”€โ”€ page.tsx            # Business hub
โ”‚   โ”œโ”€โ”€ sme/                # SME services
โ”‚   โ”œโ”€โ”€ salary/             # Payroll management
โ”‚   โ”œโ”€โ”€ enterprise/         # Enterprise features
โ”‚   โ””โ”€โ”€ gateway/            # Payment gateway
โ”œโ”€โ”€ me/
โ”‚   โ”œโ”€โ”€ page.tsx            # Account overview
โ”‚   โ”œโ”€โ”€ profile/            # User profile
โ”‚   โ”œโ”€โ”€ settings/           # Account settings
โ”‚   โ”œโ”€โ”€ kyc/                # KYC verification
โ”‚   โ”œโ”€โ”€ recovery/           # Account recovery
โ”‚   โ”œโ”€โ”€ wallet/             # Wallet management
โ”‚   โ”œโ”€โ”€ activity/           # Activity history
โ”‚   โ””โ”€โ”€ 2fa/                # Two-factor auth
โ”œโ”€โ”€ savings/                # Savings accounts
โ”œโ”€โ”€ lending/                # Lending products
โ”œโ”€โ”€ bills/                  # Bill payments
โ””โ”€โ”€ auth/
    โ”œโ”€โ”€ signin/             # Sign in
    โ””โ”€โ”€ 2fa/                # 2FA verification

components/
โ”œโ”€โ”€ mobile-nav.tsx          # Bottom navigation
โ”œโ”€โ”€ app-layout.tsx          # Main layout wrapper
โ””โ”€โ”€ ui/                     # shadcn/ui components

docs/
โ”œโ”€โ”€ ARCHITECTURE.md         # Detailed architecture
โ”œโ”€โ”€ ROUTES.md              # Complete routing guide
โ””โ”€โ”€ README.md              # This file

๐ŸŽจ Design System

Colors

  • Primary: Purple/Indigo (oklch(0.35 0.12 280))
  • Accent: Teal/Cyan (oklch(0.55 0.15 160))
  • Neutrals: Grayscale (white, grays, black)
  • Currency: AFK only (no USD, Stellar, or external references)

Typography

  • Headings: Use font-sans for consistency
  • Body: Consistent 14px+ font sizes
  • Line Height: 1.4-1.6 for readability

Layout

  • Mobile-First: Optimized for mobile devices
  • Flexbox: Primary layout method
  • Max Width: 28rem (md breakpoint) for content
  • Bottom Padding: 24 (96px) for mobile nav visibility

๐Ÿ’ฐ Currency System

The application uses AFK (ACBU) as the only currency:

  • All balances displayed in AFK
  • All transactions in AFK
  • All fees in AFK
  • Stellar network for blockchain operations
  • No USD, USDC, or external currency conversions

Key Numbers

  • 1 AFK = 1 unit of native ACBU
  • Network fee: Free (Stellar protocol)
  • Processing fees: 0.50-1.00 AFK per operation
  • Exchange displayed in rates tabs (informational only)

๐Ÿ” Security & Authentication

Current Implementation

  • Mock authentication (ready for integration)
  • Placeholder user data
  • 2FA flow structure ready
  • KYC verification workflow

Production Ready

  • Input validation on all forms
  • Error handling for API operations
  • Secure session management pattern
  • Ready for API.acbu.io integration

๐Ÿš€ Features

Core Features

  • P2P Transfers: Send money between wallets with frequent recipient management
  • Mint/Burn: Create and redeem AFK currency
  • Business Services: Complete suite for SME, payroll, and enterprise
  • Account Management: Profile, settings, KYC, recovery
  • Savings & Lending: Interest-bearing accounts and loan products
  • Bill Payments: Utilities, airtime, and services

In-Page Navigation

Features are grouped logically with internal navigation:

  • Send page includes tabs for P2P, Mint/Burn, International, History
  • Mint page includes tabs for Mint, Burn, Rates
  • Business page includes cards for all business services

๐Ÿ“ฑ Mobile Experience

Navigation

  • 5-item bottom tab bar: Persistent across all pages
  • Active state: Current route highlighted in primary color
  • Touch-friendly: Large tap targets (56px minimum)
  • Icon + Label: Clear identification

Responsive

  • Mobile-first design: Optimized for 375px-430px width
  • Max width: 28rem for content containers
  • Proper spacing: Consistent 16px padding
  • Safe area: Bottom padding for iOS notch support

๐Ÿ”— API Integration

Ready for Integration

All pages include mock data structures ready for real API calls:

Base URL: https://api.acbu.io

Key Endpoints (to be implemented):
POST   /send              # Create transfer
GET    /send/history      # Get transfers
POST   /mint              # Mint operation
POST   /burn              # Burn operation
GET    /account           # User account
GET    /business          # Business services
POST   /kyc/start         # Start KYC
GET    /bills/catalog     # Bill catalog
POST   /bills/pay         # Pay bill

๐Ÿ›  Development

Technologies

  • Framework: Next.js 16 with App Router
  • UI Library: React 19 with shadcn/ui
  • Styling: Tailwind CSS v4
  • Icons: Lucide React
  • State: React hooks (SWR ready)

Key Files to Know

  • /components/mobile-nav.tsx - Navigation configuration
  • /components/app-layout.tsx - Layout wrapper
  • /app/globals.css - Design tokens and theme
  • /docs/ROUTES.md - Complete routing reference
  • /docs/ARCHITECTURE.md - Architecture details

๐Ÿ“š Documentation

  • ARCHITECTURE.md - System design and principles
  • ROUTES.md - Complete routing guide with examples
  • README.md - This file

๐ŸŽฏ Next Steps

  1. API Integration: Connect to api.acbu.io endpoints
  2. Authentication: Replace mock auth with real implementation
  3. Database: Set up transaction and user data persistence
  4. Testing: Add unit and integration tests
  5. Deployment: Deploy to Vercel with environment variables

๐Ÿ“ Notes

  • Currency: All USD references have been removed; AFK is the only currency
  • Navigation: New mobile nav with 5 primary tabs (Home, Send, Mint, Business, Me)
  • Structure: Organized architecture makes it easy to add new features
  • Scalability: Each section is modular and can grow independently
  • Accessibility: WCAG 2.1 compliant with semantic HTML

Contributors

Junman140temisan0xN-thnIJohnpii1likableaiakinteweDavisVTJohnOluBEmmanex01Smartdevs17shogun444chiemezie1Jujukoderqueentiffany1111-cloudpchieneyecoderchris1234Godsmiracle001senmalongD-KILLJOYPetJsChrisland58lekescrew22viktrifiedfunds0033-cmykJemimahEkongveloura-devnede110legend4techzeemscriptbradleyfernando

Issues