Shortas Documentation

Welcome to Shortas Documentation

**Shortas** is a high-performance URL shortener built with Rust, featuring advanced analytics, multi-tenancy, and real-time click tracking.

Production Ready High Performance Enterprise Grade

🚀 Quick Start

Get up and running with Shortas in minutes! Our one-command setup will install dependencies, start infrastructure, build services, and run tests. 
# Clone the repository
git clone https://github.com/FlyingCow/shortas.git
cd shortas

# Complete development setup
make dev-setup

# Start all services
make dev-start
Get Started Installation Guide

🏗️ Architecture Overview

Microservices Architecture

Shortas is built as a microservices architecture with five main components, each designed for specific responsibilities and optimized for performance.

🚀

Click Router

A high-performance, intelligent URL redirection service with advanced routing capabilities, conditional logic, analytics, and multi-database support for enterprise-grade URL shortening.

Learn More
📊

Click Tracker

Real-time click processing and data enrichment with geographic and device analytics.

Learn More
⚡

Click Aggregator

Analytics data processing and storage with high-performance batch processing.

Learn More
🔧

Click Router API

High-performance, secure API with JWT authentication via Keycloak, comprehensive OpenAPI documentation, and support for multiple database backends.

Learn More
📈

Click Aggregator API

High-performance, secure click aggregation API with JWT authentication via Keycloak, comprehensive OpenAPI documentation, and ClickHouse integration for analytics.

Learn More

📚 Documentation Sections

🚀 Getting Started
🏗️ Architecture
📡 API Reference
🚀 Deployment
🛠️ Development

🛠️ Technology Stack

Modern Technology Stack
🦀

Rust

Systems programming language for performance and safety

🌐

Salvo

Modern web framework for Rust

🗄️

MongoDB

Primary document database

⚡

ClickHouse

Analytics and OLAP database

🚀

Redis

Caching and session storage

☁️

AWS

Cloud infrastructure and services

🚀 Key Features

🔄 Routing & Redirects
  • Multiple redirect types (301, 302, proxy, retargeting)
  • Domain-based routing with wildcard support
  • SSL certificate management
  • Deep link support
  • A/B testing capabilities
📊 Analytics & Tracking
  • Real-time click tracking
  • Geographic analytics (country, continent, location)
  • Device and browser analytics
  • Session tracking and user behavior
  • Bot detection and filtering
  • Unique visitor tracking
🏢 Multi-tenancy
  • Workspace-based isolation
  • User and creator role management
  • Owner-based data segregation
  • Custom user settings per workspace

📊 Performance

High Performance Metrics - Shortas is designed for enterprise-scale performance with sub-millisecond response times.
🚀

Click Router

10,000+ requests/second

📊

Click Tracker

50,000+ events/second

⚡

Click Aggregator

100,000+ records/second

🔧

APIs

5,000+ requests/second

🔗 Quick Links

GitHub Repository Issue Tracker Contributing Guide API Documentation

📄 License

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

Need help? Check out our Getting Started Guide or open an issue on GitHub.