Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Andr21Da16/Quikko/llms.txt

Use this file to discover all available pages before exploring further.

Quikko is a modern, full-stack URL shortener platform engineered for speed and observability. The Go backend resolves redirects in sub-millisecond time by consulting Redis before touching any database, while InfluxDB captures every click as a time-series event and WebSockets push those metrics to the dashboard the instant they happen — no polling required. Whether you need a self-hosted link management tool or a foundation to build on, Quikko ships with everything: authentication, QR code generation, GeoIP detection, CSV export, and a fully documented REST API.

Key Capabilities

URL Shortening

Create, edit, activate, deactivate, and delete short links. Automatic QR code generation and strict URL validation are included out of the box.

Real-Time Analytics

Every click is recorded to InfluxDB with timestamp, country, browser, OS, and device data. Query per-URL or global statistics from the dashboard.

Live Dashboard

A persistent WebSocket connection pushes click events to every connected client the moment they are recorded — no page refresh needed.

QR Codes

Each short URL is automatically paired with a QR code, ready for download and embedding in print or digital materials.

Docker-Ready Infra

A single docker compose up -d spins up MongoDB, Redis, and InfluxDB so you can run the full platform locally in minutes.

OpenAPI / REST

The entire API is documented with OpenAPI and served interactively via Swagger UI at /docs.

Tech Stack

BackendFrontend
GoNext.js 16
EchoReact 19
MongoDBTypeScript
RedisTailwind CSS v4
InfluxDBZustand
JWTFramer Motion
WebSocketD3.js
Docker

Architecture Overview

Quikko is organized as a monorepo with two independent applications:
  • quikko/server/ — Go REST API built on Clean Architecture principles. Each domain (Auth, URL Shortener, Redirect, Analytics, Realtime) is fully isolated, and infrastructure adapters (MongoDB, Redis, InfluxDB) are injected at startup.
  • quikko/client/ — Next.js App Router dashboard. UI components never call the backend directly; all HTTP traffic flows through a centralized API client, then into domain-specific Zustand stores.
Both applications can be run independently or together as a unified platform. See the Architecture page for a detailed breakdown of the data flow.

Live Demo

The demo environment is automatically deployed from the latest commit on the main branch, so it always reflects the current state of the project.

License

Quikko is open-source software released under the MIT License. You are free to use, modify, and distribute it for personal or commercial projects. See the LICENSE file in the repository root for full terms.

Build docs developers (and LLMs) love