Brev.ly - URL Shortener

A fullstack URL shortener application with analytics and reporting.

Features

• 🔗 Create shortened URLs
• 📋 List all shortened URLs
• 🗑️ Delete URLs
• 📊 Usage reports and analytics
• ↪️ Automatic redirection

Project Structure

brev.ly/
├── web/          # Frontend (React + TypeScript + Vite)
└── server/       # Backend (Node.js + TypeScript) + DevOps

Getting Started

Prerequisites

• Node.js 20+
• pnpm
• Docker (for database)

Installation & Setup

1. Backend (server)

cd server

# Install dependencies
pnpm install

# Configure environment variables
cp .env.example .env
# Edit .env with your settings

# Start the database
docker compose -f devops/docker/docker-compose.dev.yml up -d

# Run migrations
pnpm db:migrate

# Start the server
pnpm dev

The server will be running at http://localhost:3333

2. Frontend (web)

cd web

# Install dependencies
pnpm install

# Configure environment variables
cp .env.example .env
# Edit .env with your settings

# Start the development server
pnpm dev

The application will be running at http://localhost:3000

Environment Variables

Server (.env)

PORT=3333
BASE_URL=http://localhost:3333

# Database
DATABASE_URL=postgresql://postgres:postgres@localhost:5432/brevly
POSTGRES_USER=postgres
POSTGRES_PASSWORD=postgres
POSTGRES_DB=brevly
POSTGRES_PORT=5432

# Cloudflare R2 (optional - for CSV export to cloud)
CLOUDFLARE_ACCOUNT_ID=
CLOUDFLARE_ACCESS_KEY_ID=
CLOUDFLARE_SECRET_ACCESS_KEY=
CLOUDFLARE_BUCKET=brevly
CLOUDFLARE_PUBLIC_URL=

Web (.env)

VITE_FRONTEND_URL=http://localhost:3000
VITE_BACKEND_URL=http://localhost:3333

See individual README files for complete environment variable documentation.

Tech Stack

Frontend (web/)

• React 18
• TypeScript
• Vite
• TailwindCSS

Backend (server/)

• Node.js
• TypeScript
• Fastify
• PostgreSQL
• Drizzle ORM

License

MIT