<div id="top"></div> <!-- PROJECT Intro -->

<div align="center">

🔗 Pckd

<a href="https://docs.pckd.me/docs/getting-started/installation/install_intro">Quick start</a>
<span>  •  </span>
<a href="http://pckd.me/github-demo">Demo</a>
<span>  •  </span>
<a href="https://pckd.me/docs">Docs</a>
<span>  •  </span>
<a href="https://pckd.me/blog">Blog</a>
<span>  •  </span>
<a href="https://twitter.com/PckdHQ">Twitter</a>
<span>  •  </span>
<a href="https://discord.gg/cqNbdEmazR">Discord</a>
<br />

<hr /> </div>

⛔️🛑 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, etc.

<hr />

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

<p align="right">(<a href="#top">back to top</a>)</p>

📸 Screenshots

Here is a sneak peek of the application and it's visuals 😍:

<table> <tr> <td colspan="2"> <img src="https://user-images.githubusercontent.com/48997634/153762057-3b3792ec-cfd6-4994-ba77-f973b610bac8.png" alt="Dashboard Page" /> <br /> <p align="center">Dashboard Page</p> </td> </tr> <tr> <td> <img src="https://user-images.githubusercontent.com/48997634/153762072-2c1fb032-f987-4587-938b-589886d6f02d.png" alt="Login Screen" /> <br /> <p align="center">Login</p> </td> <td> <img src="https://user-images.githubusercontent.com/48997634/153762076-2d353ff0-1269-4d52-a5f8-155a2406c927.png" alt="Signup" /> <br /> <p align="center">Signup</p> </td> </tr> <tr> <td> <img src="https://user-images.githubusercontent.com/48997634/153762042-58d55b0d-61cb-4e4e-a702-a46f455d7454.png" alt="Account Page" /> <br /> <p align="center">Account Page</p> </td> <td> <img src="https://user-images.githubusercontent.com/48997634/153762075-62f5f946-93fa-4777-b663-fd8cfd6eb198.png" alt="Reset Password Screen" /> <br /> <p align="center">Reset Password</p> </td> </tr> <tr> <td colspan="2"> <img src="https://user-images.githubusercontent.com/48997634/153762070-9ce6e657-d1a3-4549-9d8b-245f1470d440.png" alt="Home Page" /> <br /> <p align="center">Home Page</p> </td> </tr> </table>

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

<p align="right">(<a href="#top">back to top</a>)</p> <!-- Motivation -->

🎗 Supporters

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

😇 One-off Backers

<!-- readme: contributors -start --> <table> <tr> <td align="center"> <a href="https://github.com/geekedtv"> <img src="https://avatars.githubusercontent.com/u/57927413?v=4" width="100;" alt="geekedtv" /> <br /> _{<b>Geeked</b>} </a> </td> <td align="center"> <a href="https://github.com/BenNotix"> <img src="https://avatars.githubusercontent.com/u/69650356?v=4" width="100;" alt="Ben Notix" /> <br /> _{<b>Ben Notix</b>} </a> </td> <td align="center"> <a href="https://github.com/rizwan95"> <img src="https://pbs.twimg.com/profile_images/845698052820090880/rbSoa4Bs_400x400.jpg" width="100;" alt="rizwan95" /> <br /> _{<b>Rizwan Ahmed</b>} </a> </td> <td align="center"> <a href="https://github.com/sponsors/PckdHQ/"> <img src="https://user-images.githubusercontent.com/48997634/174815737-111b70a6-7fd1-4ebf-a2db-7a05dd0bfb62.png" width="100;" alt="Add your support" /> <br /> _{<b>[Add your support]</b>} </a> </td> </tr> </table>

🤔 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.

<p align="right">(<a href="#top">back to top</a>)</p>

🧮 Comparison

Pckd stacks up well against major URL Shorteners

<p align="right">(<a href="#top">back to top</a>)</p>

😲 Built With (Tech Stack)

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

• ⚛️ React JS - Frontend
• 🚀 Apollo GraphQL Server v3 - Server API
• 🧩 GraphQL Template By Mohit - Boilerplate for Apollo
• 💿 Prisma - ORM
• 😨 Any relational or non-relational database that Prisma
  supports
• 🗺️ Redux w/ Redux Toolkit - State management
• 🌐 IP Registry - Free Geolocation lookups

<p align="right">(<a href="#top">back to top</a>)</p> <!-- GETTING STARTED -->

🤯 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

• 🛠 Build from source code
• 📦 [Soon] Deploy the release
• 🐳 [Unstable] Docker-Compose Installation
• 🐋 [Soon] Docker-Hub Pre-built Image

Read all installation docs here

<p align="right">(<a href="#top">back to top</a>)</p>

🛣 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.

<p align="right">(<a href="#top">back to top</a>)</p>

📐 Architecture

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

<div align="center"> <img src="https://user-images.githubusercontent.com/48997634/153762066-548fe751-e681-4af0-8672-0a459895a8b2.png" height="300" /> <p>Here's how everything fits into the scene</p> </div> <!-- CONTRIBUTING -->

🌈 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

<p align="right">(<a href="#top">back to top</a>)</p>

Contributors

<table> <tr> <td align="center"> <a href="https://github.com/just-moh-it"> <img src="https://avatars.githubusercontent.com/u/48997634?v=4" width="100;" alt="Just-Moh-it" /> <br /> _{<b>Mohit Yadav</b>} </a> </td> <td align="center"> <a href="https://github.com/itzderock"> <img src="https://avatars.githubusercontent.com/u/14848722?v=4" width="100;" alt="ItzDerock" /> <br /> _{<b>Derock</b>} </a> </td> <td align="center"> <a href="https://github.com/szilarddoro"> <img src="https://avatars.githubusercontent.com/u/10910174?s=60&v=4" width="100;" alt="rizwan95" /> <br /> _{<b>Rizwan Ahmed</b>} </a> </td> <td align="center"> <a href="https://github.com/petrleocompel"> <img src="https://avatars.githubusercontent.com/u/9423543?s=60&v=4" width="100;" alt="petrleocompel" /> <br /> _{<b>Petr Leo Compel</b>} </a> </td> <td align="center"> <a href="https://github.com/Sujith46"> <img src="https://avatars.githubusercontent.com/u/37608689?v=4" width="100;" alt="Sujith46" /> <br /> _{<b>Sujith</b>} </a> </td> </tr> </table>

👋 Author

💁🏻‍♂️ Mohit Yadav

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

<table> <tr> <td> <a href="https://discord.gg/cqNbdEmazR"> <img src="https://user-images.githubusercontent.com/48997634/153762069-df7f5900-e685-45c9-8d30-a1a73bc28a8f.png" alt="Join Discord Server" /> <p align="center">For installation support</p> </a> </td> <td> <a href="https://ko-fi.com/S6S0C37X3"> <img src="https://user-images.githubusercontent.com/48997634/174812602-496e76e1-0651-4b29-8933-4acaf2a9e89e.png" alt="Buy me a coffee" /> <p align="center">To support Projects</p> </a> </td> <td> <a href="https://mohitya.dev?utm_source=github.com&utm_medium=pckd_author_link"> <img src="https://user-images.githubusercontent.com/48997634/174813027-6b64959f-66d5-4c73-b405-a5322ed16fc9.png" alt="Visit website"> <p align="center">Awesome projects</p> </a> </td> </tr> </table> <p align="right">(<a href="#top">back to top</a>)</p> <!-- LICENSE -->

🛡 License

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

<p align="right">(<a href="#top">back to top</a>)</p>

🌟 Support this project

⏫⭐️ Scroll to the star button

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

<!-- MARKDOWN LINKS & IMAGES --> <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->