QuickTopUp VTU Platform

A simple, secure, and fast Virtual Top-Up (VTU) application for Nigerian users to recharge airtime, buy data bundles, and manage their mobile services efficiently.

📱 Features

• Airtime Top-Up: Instant recharge for all Nigerian networks (MTN, Glo, Airtel, 9mobile)
• Data Bundles: Purchase cheap SME or direct VTU data plans
• Wallet System: Secure wallet with virtual account funding via Paystack
• Transaction History: Complete record of all transactions
• Admin Panel: Comprehensive management system for users and transactions
• Reseller Support: Commission-based system for agents and small businesses

🛠 Tech Stack

Frontend

• Framework: React 18 with TypeScript
• Build Tool: Vite
• Styling: Tailwind CSS
• State Management: React Context API / Redux Toolkit
• Routing: React Router DOM
• HTTP Client: Axios

Backend

• Runtime: Node.js (v18+)
• Framework: Express.js
• Database: PostgreSQL
• Authentication: JWT
• ORM: Prisma / Sequelize
• Payment: Paystack Integration
• VTU Provider: VTPass / Clubkonnect

📂 Project Structure

QuickTopUp/
├── frontend/              # React frontend application
├── backend/               # Node.js backend application
├── docs/                  # Project documentation
├── .env.example          # Environment variables template
├── docker-compose.yml    # Docker setup (optional)
└── README.md            # This file

🚀 Quick Start

Prerequisites

• Node.js (v18 or higher)
• PostgreSQL (v14 or higher)
• npm or yarn
• Git

Installation

1. Clone the repository

   git clone https://github.com/Glor12-web/QuickTopUp.git
   cd QuickTopUp

2. Set up Backend

   cd backend
   npm install
   cp .env.example .env
   # Configure your environment variables
   npm run migrate
   npm run seed
   npm run dev

3. Set up Frontend

   cd frontend
   npm install
   cp .env.example .env
   # Configure your environment variables
   npm run dev

4. Access the application

   • Frontend: http://localhost:5173
   • Backend API: http://localhost:3000

📖 Documentation

• Frontend Setup Guide
• Backend Setup Guide
• API Documentation
• Deployment Guide

🤝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

Development Workflow

1. Fork the repository
2. Create a feature branch

   git checkout -b feature/your-feature-name

3. Make your changes
4. Write tests for your changes
5. Commit your changes

   git commit -m "feat: add your feature description"

6. Push to your branch

   git push origin feature/your-feature-name

7. Create a Pull Request

Commit Convention

We use Conventional Commits:

• feat: for new features
• fix: for bug fixes
• docs: for documentation changes
• style: for formatting changes
• refactor: for code refactoring
• test: for adding or modifying tests
• chore: for maintenance tasks

👥 Team

• Project Lead: Your Name
• Frontend Team: [Add team members]
• Backend Team: [Add team members]

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🐛 Issues & Support

Found a bug or have a feature request? Please check our Issues page.

For support, email us at support@quicktopup.com or join our Discord.

🔗 Links

• Live Demo (Coming Soon)
• API Documentation (Coming Soon)
• User Guide

⭐ Show Your Support

Give a ⭐️ if this project helped you!

---

Made with ❤️ for the Nigerian tech community