Skip to content

Latest commit

 

History

History
171 lines (135 loc) · 7.09 KB

File metadata and controls

171 lines (135 loc) · 7.09 KB

BitaURL - Enterprise URL Shortening Platform

Version License Build Status Security

🚀 Overview

BitaURL is a comprehensive, enterprise-grade URL shortening and link management platform designed for modern businesses. Built with scalability, security, and performance at its core, BitaURL provides advanced analytics, team collaboration, custom domains, and comprehensive administrative controls.

🎯 Key Features

  • URL Shortening & Management - Create, customize, and manage short links with advanced analytics
  • QR Code Generation - Dynamic QR codes with custom branding and tracking
  • File-to-Link Conversion - Secure file hosting with expirable links
  • Team Collaboration - Multi-user workspaces with role-based permissions
  • Custom Domains - White-label solution with SSL certificate management
  • Advanced Analytics - Real-time click tracking, geographic insights, and conversion metrics
  • Enterprise Admin Panel - Comprehensive platform management and monitoring
  • API-First Architecture - RESTful APIs with comprehensive documentation

🏗️ Architecture Overview

┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
│   Frontend      │    │   Admin Panel   │    │   Mobile App    │
│   (React)       │    │   (React)       │    │   (Future)      │
└─────────┬───────┘    └─────────┬───────┘    └─────────┬───────┘
          │                      │                      │
          └──────────────────────┼──────────────────────┘
                                 │
                    ┌─────────────┴───────────┐
                    │   API Gateway           │
                    │   (Spring Boot)         │
                    └─────────────┬───────────┘
                                  │
          ┌───────────────────────┼───────────────────────┐
          │                       │                       │
    ┌─────┴─────┐         ┌─────┴─────┐         ┌─────┴─────┐
    │ MongoDB   │         │   Redis   │         │  External │
    │ Database  │         │   Cache   │         │ Services  │
    └───────────┘         └───────────┘         └───────────┘

📚 Documentation Structure

Core Documentation

Component Documentation

Operations & Security

Development

🛠️ Technology Stack

Frontend

  • Framework: React 18 with TypeScript
  • Styling: Tailwind CSS with Shadcn/UI components
  • State Management: Context API with custom hooks
  • Routing: React Router v6
  • HTTP Client: Axios with interceptors
  • Authentication: JWT with Google OAuth2

Backend

  • Framework: Spring Boot 3.x with Java 17
  • Security: Spring Security with JWT
  • Database: MongoDB with Spring Data
  • Caching: Redis for session and data caching
  • API Documentation: OpenAPI 3.0 (Swagger)
  • File Storage: AWS S3 compatible storage

Infrastructure

  • Frontend Hosting: Vercel with CDN
  • Backend Hosting: Render with auto-scaling
  • Database: MongoDB Atlas (Multi-region)
  • Cache: Redis Cloud (High Availability)
  • Monitoring: Grafana + Prometheus
  • CI/CD: GitHub Actions

🚦 Quick Start

Prerequisites

  • Node.js 18+ and npm/yarn
  • Java 17+ and Maven
  • MongoDB 6.0+
  • Redis 7.0+

Development Setup

# Clone the repository
git clone https://github.com/bitaurl/bitaurl.git
cd bitaurl

# Setup backend
cd backend
mvn clean install
mvn spring-boot:run

# Setup frontend
cd ../frontend
npm install
npm start

# Setup admin panel
cd ../admin-panel
npm install
npm start

For detailed setup instructions, see Getting Started Guide.

📊 Project Status

Current Version: 1.0.0

  • ✅ Core URL shortening functionality
  • ✅ User authentication and authorization
  • ✅ QR code generation and management
  • ✅ File-to-link conversion
  • ✅ Team collaboration features
  • ✅ Custom domain support
  • ✅ Advanced analytics dashboard
  • ✅ Enterprise admin panel
  • ✅ Payment integration (Razorpay)
  • ✅ Support ticket system

Roadmap

  • 🔄 Mobile application (React Native)
  • 🔄 Advanced API rate limiting
  • 🔄 Webhook system for integrations
  • 🔄 Advanced reporting and exports
  • 🔄 Multi-language support
  • 🔄 Enterprise SSO integration

🤝 Contributing

We welcome contributions from the community. Please read our Contributing Guide for details on our code of conduct and the process for submitting pull requests.

📄 License

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

🆘 Support

🏢 Enterprise

For enterprise licensing, custom deployments, and dedicated support, contact us at enterprise@bitaurl.com.


Built with ❤️ by the BitaURL Team