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 production-ready URL shortener platform built for speed and observability. The Go backend resolves short links from Redis in sub-millisecond time, records every click asynchronously to InfluxDB, and streams live updates to connected dashboards over WebSocket. The Next.js frontend gives users a responsive dashboard to manage links, visualize analytics, and export metrics — all in real time.

Quickstart

Run the backend and frontend locally in under five minutes.

Architecture

Understand how Go, Redis, MongoDB, and InfluxDB fit together.

API Reference

Full REST API with request/response schemas and error codes.

WebSocket Protocol

Real-time click events streamed over persistent WebSocket connections.

​
What Quikko Offers

URL Shortening

Auto-generated codes or custom aliases with Redis-first resolution.

Real-time Analytics

Click counts, geo data, device/browser breakdowns via InfluxDB.

Live Dashboard

WebSocket hub pushes click events to all connected clients instantly.

QR Codes

Every short URL ships with a QR code PNG as a base64 data URI.

Plans & Limits

Free and Pro tiers with configurable rate limits and URL quotas.

Docker Deploy

One-command Docker Compose setup for MongoDB, Redis, and InfluxDB.

​
Get Running in Minutes

1

Clone and start infrastructure

git clone https://github.com/Andr21Da16/Quikko.git
cd Quikko/server
cp .env.example .env
docker compose up -d
2

Start the Go backend

go run cmd/api/main.go
# API listening on http://localhost:8080
3

Start the Next.js frontend

cd ../client
pnpm install
pnpm dev
# Dashboard at http://localhost:3000
4

Create your first short link

curl -X POST http://localhost:8080/api/v1/urls \
  -H "Authorization: Bearer <accessToken>" \
  -H "Content-Type: application/json" \
  -d '{"originalUrl": "https://example.com"}'
A live demo is available at quikko.vercel.app with the Swagger UI at quikko-production.up.railway.app/docs.

Build docs developers (and LLMs) love

Get started for freeTalk to us