Skip to content

hirebarend/lnkbrd

Repository files navigation

Link Bird

An open-source API-first URL shortener
Learn more »

Introduction · Features · Get Started · Contributing

License


Introduction

Link Bird is an open-source API-first URL shortener

Features

  • Analytics: Track every click with real-time analytics, offering detailed insights to understand your audience and optimize performance.
  • Geo-Targeting: Redirect users to location-specific destinations, creating tailored experiences for a global audience.
  • Custom Open Graph: Customize how your links appear on social media with personalized titles, descriptions, and thumbnails.
  • Time-Limited Links: Set expiration dates for your links to ensure they remain active only as long as you need them.
  • Notifications: Receive instant notifications for link events, enabling seamless automation with your favorite tools.

Get Started

git clone https://github.com/hirebarend/lnkbrd.git

cd lnkbrd

npm install

npm run dev

Docker

curl -o prod.env.encrypted https://raw.githubusercontent.com/hirebarend/lnkbrd/refs/heads/main/prod.env.encrypted

gpg -o prod.env -d prod.env.encrypted

curl -sL https://raw.githubusercontent.com/hirebarend/lnkbrd/refs/heads/main/docker-compose.yaml | docker compose -f - up -d

Contributing

We love our contributors! Here's how you can contribute:

  • Open an issue if you believe you've encountered a bug.
  • Make a pull request to add new features/make quality-of-life improvements/fix bugs.

Repo Activity

Alt

License

Inspired by Plausible, Link Bird is open-source under the MIT License. You can find it here.

About

Link Bird is an open-source API-first URL shortener

Resources

License

Stars

Watchers

Forks