A fast URL shortener with analytics dashboard and custom domain support.

• Next.js 14 (App Router) - Full-stack React framework
• TypeScript - Type safety throughout
• PostgreSQL - Database via Vercel Postgres or Neon
• Prisma - Type-safe ORM
• Tailwind CSS - Styling
• Vercel - Deployment with edge functions

• Node.js 20+
• PostgreSQL database (local or hosted)

1. Clone the repository:

   git clone <repo-url>
   cd shorty

2. Install dependencies:

   npm install

3. Set up environment variables:

   cp .env.example .env.local

   Edit .env.local with your database URL and other settings.

4. Generate Prisma client:

   npm run db:generate

5. Run database migrations:

   npm run db:migrate

6. Start the development server:

   npm run dev

7. Open http://localhost:3000 in your browser.

shorty/
├── app/                    # Next.js App Router
│   ├── (dashboard)/        # Dashboard routes
│   ├── [slug]/             # Redirect handler (edge)
│   └── api/                # API routes
├── components/             # React components
├── lib/                    # Utilities and helpers
├── prisma/                 # Database schema
└── public/                 # Static assets

Production: https://shorty-ten-lime.vercel.app

This project is configured for deployment on Vercel:

# Link to Vercel (first time)
vercel link

# Deploy to preview/staging
vercel

# Deploy to production
vercel --prod

Set the following environment variables in your Vercel project:

1. Go to Vercel Dashboard → Your Project → Storage
2. Add Neon Postgres integration
3. The DATABASE_URL and DIRECT_URL will be automatically configured
4. Run migrations: npx prisma db push

The project includes comprehensive monitoring capabilities:

• Health Check Endpoint: GET /api/health - Returns database status and application health
• Error Tracking: Sentry integration for error capture and performance monitoring
• Structured Logging: JSON-formatted logs in production for log aggregation

1. Set up Sentry:

   SENTRY_DSN="your-sentry-dsn"
   NEXT_PUBLIC_SENTRY_DSN="your-sentry-dsn"

2. Configure uptime monitoring to poll /api/health

See docs/MONITORING.md for full monitoring documentation including alerting setup.

The project uses Vitest for testing. Tests are organized as follows:

lib/__tests__/           # Unit tests for utilities
  ├── validators.test.ts # Zod schema validation tests
  ├── utils.test.ts      # Utility function tests
  └── geo.test.ts        # Geolocation helper tests
app/api/__tests__/       # API integration tests
  ├── links.test.ts      # Links API tests
  └── domains.test.ts    # Domains API tests

Run all tests:

npm run test:run

• URL validator accepts any protocol: The Zod .url() validator accepts any valid URL including ftp://, file://, etc. For a URL shortener, you may want to restrict to http:// and https:// only.
• Domain verification requires DNS propagation: After adding a TXT record, DNS propagation can take up to 48 hours. The verification endpoint will fail until propagation completes.
• No rate limiting: API endpoints have no rate limiting implemented. For production, add rate limiting to prevent abuse.
• No authentication: The dashboard and API are currently unprotected. Add authentication before deploying to production.

• Add user authentication (e.g., NextAuth.js)
• Implement rate limiting
• Add link expiration dates
• Add QR code generation
• Add bulk link creation/import
• Add link password protection

MIT