https://github.com/nelsontky/gh-pages-url-shortener

Minimal URL shortener that can be entirely hosted on GitHub pages.
https://github.com/nelsontky/gh-pages-url-shortener

bitly github-page self-hosted serverless short-url shorten-urls shortener shorturl tinyurl url-shortener url-shorteners urlshortener

Last synced: about 1 month ago
JSON representation

Minimal URL shortener that can be entirely hosted on GitHub pages.

• Host: GitHub
• URL: https://github.com/nelsontky/gh-pages-url-shortener
• Owner: nelsontky
• License: gpl-3.0
• Created: 2020-11-13T12:50:05.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-26T14:17:31.000Z (7 months ago)
• Last Synced: 2024-10-31T15:44:54.338Z (2 months ago)
• Topics: bitly, github-page, self-hosted, serverless, short-url, shorten-urls, shortener, shorturl, tinyurl, url-shortener, url-shorteners, urlshortener
• Language: HTML
• Homepage: https://ccb.wtf/1
• Size: 89.8 KB
• Stars: 1,334
• Watchers: 13
• Forks: 504
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• starred - nelsontky/gh-pages-url-shortener - Minimal URL shortener that can be entirely hosted on GitHub pages. (HTML)
• jimsghstars - nelsontky/gh-pages-url-shortener - Minimal URL shortener that can be entirely hosted on GitHub pages. (HTML)

README

        
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

![GitHub stars](https://img.shields.io/github/stars/nelsontky/gh-pages-url-shortener?style=social)

# 🔗 GitHub Pages URL Shortener

This is a minimal URL shortener that can be entirely hosted on GitHub pages. It

does not need the maintenance of any servers or databases and can be hosted

entirely on GitHub for free!

[Yay! We got to the top of HN!](https://news.ycombinator.com/item?id=25110879)



And on GitHub trending!



## 👨‍🏫 Demo

1. [ccb.wtf/1](https://ccb.wtf/1) should link to this repo.

1. To add a new short link, add an issue with the title being the link you want

   to shorten (including the `http(s)://`) to

   [https://github.com/nelsontky/gh-pages-url-shortener-db/issues](https://github.com/nelsontky/gh-pages-url-shortener-db/issues).

1. The newly created short url can be accessed via `ccb.wtf/{issue_number}`

## ☕️ Features

1. Unlike many URL shorteners, this one ~~does not need a database~~ uses a

   "database" in the form of GitHub issues and can be entirely hosted on GitHub

   pages.

1. There is no need for the pound symbol - short URLs look clean like this:

   `ccb.wtf/1` instead of looking like this: `ccb.wtf/#1`.

## 💡 How does this work?

_Thanks to @kidGodzilla for the pretty neat explanation

[here](https://github.com/nelsontky/gh-pages-url-shortener/issues/5#issuecomment-728040879)._

> 1. 404.html handles all requests

> 1. Small javascript snippet fetches a JSON representation of the GitHub issue

>    via the JSON API, and redirects to the issue title, as a URL.

> 1. Profit?

## 😎 This is so cool! How can I use this with my own domain?!

_Disclaimer: This method of creating a URL shortener is hacky and not meant to

be reliable. Do proceed at your own risk!_

1. Fork the repo before cloning your fork.

1. Set up GitHub pages for your forked repo.

   1. In your forked repo, **click the Settings tab** and scroll down to the

      GitHub Pages section.

   1. Then select the **main branch** source and click on the **Save** button.

   1. 

1. If you are using your own domain:

   1. [Set your domain up for GitHub pages.](https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site#configuring-an-apex-domain)

   1. Change the URL in `CNAME` file to your domain.

1. If you are using GitHub page's default domain i.e. Something like

   `https://.github.io//`

   1. Delete the `CNAME` file.

   1. Change `var PATH_SEGMENTS_TO_SKIP = 0;` at the top of `404.html` to

      `var PATH_SEGMENTS_TO_SKIP = 1;`.

      1. This is as GitHub domains have an additional path segment (the repo

         name) after the host name.

1. Create a new repo as a database. (Or you could use your forked repo)

   1. Update `var GITHUB_ISSUES_LINK = "";` at the top

      of `404.html` accordingly afterwards.

      1. Format for `GITHUB_ISSUES_LINK`:

         `https://api.github.com/repos/{owner}/{repo}/issues/`

      1. Remember the trailing `/`!

1. Push your changes to your forked repo, and your low cost and cool as heck URL

   shortener will be ready for use!

## 🍴 Featured forks

To feature your fork here, edit this section and open a PR!

- [eexit.github.io/s](https://github.com/eexit/s) - Created a bash script that

  allows for shortening of URLs straight on the command line! Check out his

  script

  [here](https://github.com/nelsontky/gh-pages-url-shortener/issues/49#issue-745134937).

- [gh-short-url](https://github.com/mayandev/gh-short-url) - A npm command line

  tool that uses GitHub pages to convert short URLs.