Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Just-Moh-it/Pckd

The ⚡️ analytics-intensive, self-hostable link-shortener with a beautiful UI | AKA free bit.ly alternative 🚀
https://github.com/Just-Moh-it/Pckd

bitly customizable graphql javascript link-shortener nodejs react reactjs redux self-hosted tracking url url-shortener

Last synced: 2 months ago
JSON representation

The ⚡️ analytics-intensive, self-hostable link-shortener with a beautiful UI | AKA free bit.ly alternative 🚀

Host: GitHub
URL: https://github.com/Just-Moh-it/Pckd
Owner: Just-Moh-it
License: mit
Archived: true
Created: 2021-10-22T16:54:58.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2022-11-27T19:08:05.000Z (about 2 years ago)
Last Synced: 2024-10-28T02:11:59.048Z (3 months ago)
Topics: bitly, customizable, graphql, javascript, link-shortener, nodejs, react, reactjs, redux, self-hosted, tracking, url, url-shortener
Language: JavaScript
Homepage: https://docs.pckd.me/
Size: 14.9 MB
Stars: 784
Watchers: 13
Forks: 95
Open Issues: 29
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md

Awesome Lists containing this project

awesome - Just-Moh-it/Pckd - The ⚡️ analytics-intensive, self-hostable link-shortener with a beautiful UI | AKA free bit.ly alternative 🚀 (JavaScript)
project-awesome - Just-Moh-it/Pckd - The ⚡️ analytics-intensive, self-hostable link-shortener with a beautiful UI | AKA free bit.ly alternative 🚀 (JavaScript)
awesome-url-shortener - Just-Moh-it/Pckd

README

        


![Pckd](https://user-images.githubusercontent.com/48997634/157104510-21df472c-d0d9-4075-96f1-18aded5905a5.png)



  # 🔗 Pckd

  Quick start

    •  

  Demo

    •  

  Docs

    •  

  Blog

    •  

  Twitter

    •  

  Discord

  


  




# ⛔️🛑 This version of the project is not currently being maintained

We're focusing our efforts towards creating Pckd V2, since further development/improvements on V1 won't be sustainable. Therefore, we can't guarantee solutions to all problems at the time. Please check back in a few months for Pckd V2. Until then, try out other awesome URL shorteners like [dub](https://github.com/steven-tey/dub), [etc.](https://github.com/738/awesome-url-shortener#self-hosting-opensource)



[](https://user-images.githubusercontent.com/48997634/174793049-67f58409-a449-442f-913c-6a7859a7bf29.png)

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

- 🔗 Shorten URLs (or `pckd`s) 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](https://www.prisma.io/docs/reference/database-reference/supported-databases)

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

    

  

  

    

      

      


      Login

    

    

      

      


      Signup

    

  

  

    

      

      


      Account Page

    

    

      

      


      Reset Password

    

  

  

    

      

      


      Home Page

    

  

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

Figma](https://www.figma.com/file/CWmPgKuSWm6dvihp1XXTn1/Pckd-2?node-id=230%3A427)

(back to top)


## 🎗 Supporters

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

### 😇 One-off Backers

  

    

      

        

        


        _Geeked

      

    

    

      

        

        


        _{Ben Notix}

      

    

    

      

        

        


        _{Rizwan Ahmed}

      

    

    

      

        

        


        _{[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](https://user-images.githubusercontent.com/48997634/174783368-41a35e85-bcda-4d12-adc6-b21a9d3ffc39.png)

(back to top)


## 😲 Built With (Tech Stack)

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

- ⚛️ [React JS](https://reactjs.org/) - Frontend

- 🚀 [Apollo GraphQL Server v3](https://www.apollographql.com/docs/apollo-server/) - Server API

- 🧩 [GraphQL Template By Mohit](https://github.com/Just-Moh-it/grapqhl-backend) - Boilerplate for Apollo

- 💿 [Prisma](https://www.prisma.io/) - ORM

- 😨 Any relational or non-relational [database that Prisma

supports](https://www.prisma.io/docs/reference/database-reference/supported-databases)

- 🗺️ [Redux](https://redux.js.org/) w/ [Redux Toolkit](https://redux-toolkit.js.org/) - State management

- 🌐 [IP Registry](https://ipregistry.co/) - Free Geolocation lookups

(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](https://ipregistry.co/) for Geo-location look-ups to track hits (free for 100,000 lookups)

Obtain an **API key** from the [ipregistry.co](https://ipregistry.co) website

## 💾 Installation

Pckd supports the following installations

- 🛠 [Build from source code](https://docs.pckd.me/docs/install-from-code)

- 📦 [Soon] [Deploy the release](https://docs.pckd.me/docs/install-from-release)

- 🐳 [Unstable] [Docker-Compose Installation](https://docs.pckd.me/docs/install-from-dockerhub)

- 🐋 [Soon] [Docker-Hub Pre-built Image](https://docs.pckd.me/docs/install-from-docker-compose)

Read all installation docs [here](https://docs.pckd.me/docs/getting-started/installation/install_intro)

(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](https://github.com/PckdHQ/Pckd/discussions/49))

- Admin Panel Support (Discussion [#43](https://github.com/PckdHQ/Pckd/issues/43))

- Multiple Subdomain Support (Discussion [#14](https://github.com/PckdHQ/Pckd/issues/14))

- Email Notifications for hits if enabled (Discussion [#18](https://github.com/PckdHQ/Pckd/issues/18))

- Custom OG Preview for social-sharing (Discussion [#39](https://github.com/PckdHQ/Pckd/discussions/39))

- One-Click Deploys (Discussion [#44](https://github.com/PckdHQ/Pckd/discussions/44))

- Password-protected links (Discussion [#41](https://github.com/PckdHQ/Pckd/discussions/41))

Have a look at the 🛣 [Roadmap](https://github.com/Just-Moh-it/Pckd/issues) 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`](contributing.md)

(back to top)


# Contributors

  

    

      

        

        


        _{Mohit Yadav}

      

    

    

      

        

        


        _Derock

      

    

    

      

        

        


        _{Rizwan Ahmed}

      

    

    

      

        

        


        _{Petr Leo Compel}

      

    

    

      

        

        


        _Sujith

      

    

  

# 👋 Author

### 💁🏻‍♂️ Mohit Yadav

You can reach out to Mohit Yadav, the maintainer of the app on [Twitter](https://twitter.com/Just_Moh_it), [[email protected]](mailto:[email protected]) or

[Discord](https://discord.gg/cqNbdEmazR)

  

    

      

        

        
For installation support


      

    

    

      

        

        To support Projects

      

    

    

      

        

        Awesome projects

      

    

  

(back to top)


# 🛡 License

Distributed under the **MIT License**. See [`LICENSE.md`](LICENSE.md) for more information.

(back to top)


# 🌟 Support this project

![](https://user-images.githubusercontent.com/48997634/174794647-0c851917-e5c9-4fb9-bf88-b61d89dc2f4f.gif)

### [⏫⭐️ Scroll to the star button](#start-of-content)

If you believe this project has potential, feel free to **star this repo** just like many [amazing people](/stargazers)

have.

[contributors-shield]: https://img.shields.io/github/contributors/Just-Moh-it/Pckd.svg?style=flat-square&logo=github

[contributors-url]: https://github.com/Just-Moh-it/Pckd/graphs/contributors

[last-commit-shield]: https://img.shields.io/github/last-commit/Just-Moh-it/Pckd?style=flat-square&logo=anchor

[last-commit-url]: https://github.com/Just-Moh-it/Pckd/commit/main

[forks-shield]: https://img.shields.io/github/forks/Just-Moh-it/Pckd.svg?style=flat-square&logo=curseforge

[forks-url]: https://github.com/Just-Moh-it/Pckd/network/members

[stars-shield]: https://img.shields.io/github/stars/Just-Moh-it/Pckd.svg?style=flat-square&logo=Apache-Spark

[stars-url]: https://github.com/Just-Moh-it/Pckd/stargazers

[issues-shield]: https://img.shields.io/github/issues/Just-Moh-it/Pckd.svg?style=flat-square&logo=testing-library

[issues-url]: https://github.com/Just-Moh-it/Pckd/issues

[license-shield]: https://img.shields.io/github/license/Just-Moh-it/Pckd.svg?style=flat-square&logo=gmail

[license-url]: https://github.com/Just-Moh-it/Pckd/blob/master/LICENSE.md