_____ _ _ ____ ____ _____ _ _ _____
/ ____| | | | _ \| _ \| ____| \ | |_ _|
| | | | | | |_) | |_) | _| | \| | | |
| | | |_| | _ <| _ <| |___| |\ | | |
\____|\___/|_| \_\_| \_\_____|_| \_| |_|
A comprehensive URL shortener and management platform with enterprise features including custom aliases, analytics tracking, QR code generation, and role-based access control. Built with a modern three-container microservices architecture for scalability and performance.
Built for production from day one with multi-language support (Go 1.24+, Python 3.12/3.13, Node.js 18+), comprehensive CI/CD pipelines, and enterprise-grade security scanning.
- 8-stage security validation including Trivy, CodeQL, and Semgrep scanning
- TLS 1.2 minimum enforcement, preferring TLS 1.3
- Automated vulnerability detection with Dependabot and Socket.dev integration
- Secrets management with environment-based configuration
- Multi-architecture Docker builds (amd64/arm64) with Debian-slim base images
- Parallel CI/CD workflows for optimized build times
- eBPF/XDP networking support for high-performance applications
- Connection pooling and caching strategies built-in
- Centralized feature gating with
https://license.penguintech.io - Universal JSON response format across all products
- Multi-tier licensing (community/professional/enterprise)
- Usage tracking and compliance reporting
- Built-in health checks and self-healing capabilities
- Prometheus metrics and Grafana dashboard integration
- Structured logging with configurable verbosity levels
- Real-time monitoring and alerting
- Air-gapped deployment ready with local caching
- Container orchestration with Kubernetes and Helm
- Environment-specific configurations for dev/staging/production
- Blue-green deployment support with automated rollbacks
# Clone and setup
git clone <your-repository-url>
cd your-project
make setup # Install dependencies and setup environment
make dev # Start development environment- Languages: Go 1.24+, Python 3.12/3.13, Node.js 18+
- Databases: PostgreSQL with PyDAL/GORM, Redis/Valkey caching
- Containers: Docker with multi-stage builds, Kubernetes deployment
- Monitoring: Prometheus, Grafana, structured logging
- Multi-factor authentication (MFA) and JWT tokens
- Role-based access control (RBAC)
- Automated security scanning and vulnerability management
- Compliance audit logging (SOC2, ISO27001 ready)
- Comprehensive test coverage (unit, integration, e2e)
- Automated code quality checks (linting, formatting, type checking)
- Version management with semantic versioning
- Feature branch workflow with required reviews
- Getting Started: docs/development/
- API Reference: docs/api/
- Deployment Guide: docs/deployment/
- Architecture Overview: docs/architecture/
- License Integration: docs/licensing/
We welcome contributions! Please see CONTRIBUTING.md for guidelines.
- Primary: [email protected]
- General: [email protected]
- Company: www.penguintech.io
- Your name could be here! Submit a PR to get started.
- Documentation: ./docs/
- Premium Support: https://support.penguintech.group
- Community Issues: GitHub Issues
- License Server Status: https://status.penguintech.io
This project is licensed under the Limited AGPL3 with preamble for fair use - see LICENSE.md for details.
License Highlights:
- Personal & Internal Use: Free under AGPL-3.0
- Commercial Use: Requires commercial license
- SaaS Deployment: Requires commercial license if providing as a service
Companies employing official contributors receive GPL-2.0 access to community features:
- Perpetual for Contributed Versions: GPL-2.0 rights to versions where the employee contributed remain valid permanently, even after the employee leaves the company
- Attribution Required: Employee must be credited in CONTRIBUTORS, AUTHORS, commit history, or release notes
- Future Versions: New versions released after employment ends require standard licensing
- Community Only: Enterprise features still require a commercial license
This exception rewards contributors by providing lasting fair use rights to their employers. See LICENSE.md for full terms.