/Pckd

The most โšก๏ธ analytics-intensive self-hostable URL shortener, with an amazing UI | AKA free-Bitly/Shlink alternative ๐Ÿš€

Primary LanguageJavaScriptMIT LicenseMIT

Pckd

๐Ÿ”— Pckd

Quick start   โ€ข   Demo   โ€ข   Docs   โ€ข   Blog   โ€ข   Twitter   โ€ข   Discord


Pckd is a free-to-use URL Shortener, that can be easily self-hosted with awesome features like:

  • ๐Ÿ”— Shorten URLs (or pckds) with, or without an account
  • ๐Ÿ–Œ๏ธ Customize back-halfs on every pckd
  • ๐Ÿ”Œ Deploy to custom URL and Infrastructure
  • ๐Ÿงค Customize settings like link back-halfs, link targets, tracking info, etc.
  • ๐Ÿ•ต๏ธโ€โ™‚๏ธ Track each click on a pckd, and retrieve
    • ๐ŸŒ IP address (Spoof-resistant)
    • ๐Ÿ•ธ๏ธ ISP Name
    • ๐Ÿ—บ๏ธ IP-Location
    • ๐Ÿ’ป Device details like OS Version and Device Model
    • ๐ŸชŸ Browser Name and including version
  • ๐Ÿ’ฏ Custom Loading/Redirecting Screen (self-hosted only)
  • ๐Ÿƒโ€โ™‚๏ธ Quick Redirections in 150ms!
  • ๐Ÿ” Fast, Reliable and Secure
  • ๐Ÿ‘ฎ Secure Secret Storage and handling using ๐Ÿ’ป environment variables
  • โœจ Built on a modern tech stack
  • ๐Ÿ’ฟ Compatible with MySQL, PostgreSQL, MongoDB and many more

This project was created to be the most powerful URL shortener for the public, so no wonder it's so feature-rich

(back to top)

๐Ÿ“ธ Screenshots

Here is a sneak peek of the application and it's visuals ๐Ÿ˜:

Dashboard Page

Dashboard Page

Login Screen

Login

Signup

Signup

Account Page

Account Page

Reset Password Screen

Reset Password

Home Page

Home Page

Want to create your own iteration? View the designs on Figma

(back to top)

๐ŸŽ— Supporters

Pckd is made possible by support from some awesome folks including:

๐Ÿ˜‡ One-off Backers

geekedtv
Geeked
Ben Notix
Ben Notix
rizwan95
Rizwan Ahmed
Add your support
[Add your support]

๐Ÿค” Why does Pckd exist?

After looking at all the aka.ms links out there which flood windows, along with the numerous time saving been prompted to buy premium plans from bit.ly while shortening my URLs, the decision of having a reliable, personal URL shortener hosted on a custom domain for free caught wind.

(back to top)

๐Ÿงฎ Comparison

Pckd stacks up well against major URL Shorteners

Comparison Table including other free and paid shorteners

(back to top)

๐Ÿ˜ฒ Built With (Tech Stack)

The following technologies were involved in the making of this project.

(back to top)

๐Ÿคฏ Quick Start Guide

To get started with having your own instance of Pckd, follow the steps described in the following section

๐Ÿšฆ Get an API Key first

Pckd uses IP Registry for Geo-location look-ups to track hits (free for 100,000 lookups)

Obtain an API key from the ipregistry.co website

๐Ÿ’พ Installation

Pckd supports the following installations

Read all installation docs here

(back to top)

๐Ÿ›ฃ Roadmap

This project is far from perfect, and we'll reach there one day, or at least get close.

  • Link-in-bio feature (Discussion #49)
  • Admin Panel Support (Discussion #43)
  • Multiple Subdomain Support (Discussion #14)
  • Email Notifications for hits if enabled (Discussion #18)
  • Custom OG Preview for social-sharing (Discussion #39)
  • One-Click Deploys (Discussion #44)
  • Password-protected links (Discussion #41)

Have a look at the ๐Ÿ›ฃ Roadmap for a full list of proposed features and enhancements.

(back to top)

๐Ÿ“ Architecture

Here's a diagram explaining exactly how everything fits into place

Here's how everything fits into the scene

๐ŸŒˆ Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Also, refer to Contributing.md

(back to top)

Contributors

Just-Moh-it
Mohit Yadav
ItzDerock
Derock
rizwan95
Rizwan Ahmed
petrleocompel
Petr Leo Compel
Sujith46
Sujith

๐Ÿ‘‹ Author

๐Ÿ’๐Ÿปโ€โ™‚๏ธ Mohit Yadav

You can reach out to Mohit Yadav, the maintainer of the app on Twitter, yo@mohitya.dev or Discord

Join Discord Server

For installation support

Buy me a coffee

To support Projects

Visit website

Awesome projects

(back to top)

๐Ÿ›ก License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

๐ŸŒŸ Support this project

If you believe this project has potential, feel free to star this repo just like many amazing people have.