MNTZ URL Shortener

A modern, full-featured, open-source URL shortener built with Next.js, TypeScript, Prisma, and Tailwind CSS. Easily create, manage, and analyze short links with advanced analytics, branded domains, and a beautiful dashboard.

Features

• Shorten URLs: Instantly create short links for any long URL.
• Custom Slugs: Choose memorable, branded endings for your links.
• Advanced Analytics: Track clicks, devices, browsers, locations, and more (src/components/Dashboard.tsx).
• User Accounts: Manage your links and access advanced features.
• RESTful API: Programmatically create and manage links (src/app/api/shorten/route.ts).
• Responsive UI: Built with Tailwind CSS for desktop and mobile.
• Security: HTTPS, abuse monitoring, and malware scanning.
• Open Source: MIT licensed, easy to self-host and customize.

Getting Started

1. Clone the repo

   git clone https://github.com/yourusername/mntz-shortner.git
   cd mntz-shortner

2. Install dependencies

   npm install

3. Configure environment

   • Copy .env.example to .env and fill in required values (database, NEXTAUTH_URL, etc).

4. Setup database

   npx prisma migrate dev

5. Run the app

   npm run dev

6. Access the dashboard

   • Visit http://localhost:3000 in your browser.

API Usage

See src/app/user/support/docs/page.tsx for full API documentation.

Example: Create a short link

POST /api/links
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "url": "https://example.com/very/long/url",
  "customSlug": "optional-custom-slug"
}

Folder Structure

• src/ — Main source code
  • components/ — UI components (forms, dashboard, maps)
  • app/ — Next.js app routes (API, blog, user pages)
  • prisma/ — Database schema and migrations
  • public/ — Static assets
  • tests/ — Unit and integration tests
• scripts/ — Utility scripts
• .github/ — CI workflows

Contributing

Pull requests and issues are welcome! Please see CONTRIBUTING.md for guidelines.

License

MIT © Vivek Kavala

---

Live Demo: mntz.xyz

Docs: See the blog guides for best practices, SEO tips, and technical details.