Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including netlify-shortener with all npm packages installed. Try it out:

var netlifyShortener = require("netlify-shortener")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

netlify-shortener v2.2.1

Uses netlify's redirect functionality to make a personal URL shortener. Works beautifully :)

netlify-shortener

Uses netlify's redirect functionality to make a personal URL shortener. Works beautifully :)


[![Build Status][build-badge]][build] [![Code Coverage][coverage-badge]][coverage] [![version][version-badge]][package] [![downloads][downloads-badge]][npmtrends] [![MIT License][license-badge]][license] [![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors-) [![PRs Welcome][prs-badge]][prs] [![Code of Conduct][coc-badge]][coc]

The problem

You want a URL shortener for your custom domain and you want an easy way to create and update URLs but you don't want to pay hundreds of dollars a year.

This solution

This relies on Netlify's _redirects file for building a super simple URL shortener where the URLs are managed on GitHub and Netlify handles the redirecting for you.

Table of Contents

Installation

This module is distributed via [npm][npm] which is bundled with [node][node] and should be installed as one of your project's devDependencies:

npm install --save-dev netlify-shortener

Usage

Your project should have a _redirects file that looks like this:

/example http://example.com

# fallback
/*       https://your-website.com

This module exposes a binary that you should use in your package.json scripts. You also need to add a baseUrl to your package.json:

{
  "baseUrl": "https://jsair.io",
  "scripts": {
    "shorten": "netlify-shortener"
  }
}

Then you can run:

npm run shorten # simply formats your _redirects file
npm run shorten https://yahoo.com # generates a short code and adds it for you
npm run shorten https://github.com gh # adds gh as a short URL for you

The netlify-shortener does a few things:

  1. generates a short code if one is not provided
  2. validates your URL is a real URL
  3. adds the URL to the top of _redirects
  4. runs a git commit and push (this will trigger netlify to deploy your new redirect)
  5. Copies the short URL to your clipboard

Netlify's deploys are normally fast enough that the new URL should be deployed by the time you've shared it to someone.

Shell Function

If you want to be able to run this anywhere in the terminal, you can try making a custom function for your shell.

Shell Agnostic

  1. Add the following executable definition to your package.json:
    {"bin": {"shorten": "cli.js"}}
    
  2. Create the cli.js file:
    #!/usr/bin/env node
    require('netlify-shortener')
    
  3. From your project directory, run the following to register the command globally:
    npm link
    

Bash

Place this in your ~/.bash_profile file:

shorten() { node {path-to-local-repo}/node_modules/.bin/netlify-shortener "$1" "$2"; }

Fish

Place this in ~/.config/fish/functions/shorten.fish:

function shorten --description "Shorten a URL"
  node {path-to-local-repo}/node_modules/.bin/netlify-shortener $argv
end

(Alternatively, run funced -s shorten and Fish will open your editor. Paste this code into the opened file.)

Windows (cmd)

Using Cmder, add this to your user-alias.cmd file.

shorten=cmd /c "cd /d {path-to-local-repo} && npm run shorten $1 $2"

FAQ

What about analytics?

I don't think Netlify will give you analytics, but you should be able to set up CloudFlare in front of your domain and I think they'll give you analytics.

Can I keep my links private?

Netlify doesn't charge for linking up private repositories (HOW COOL IS THAT!?) so you can make your GitHub repo private and that should keep your links private.

Inspiration

URL shorteners for custom domains and custom short codes are insanely expensive. Hiveam.com was the best price-wise, but the price went up and it's super expensive as well.

So I tried writing a custom netlify function and it worked pretty well, but then I was tipped off by smart people that using Netlify's built-in _redirects functionality would work well and it does!

So I built this tool to make it easier to do this for the two domains I need this for and now you can use it too!

Other Solutions

If you know more alternatives, please [make a pull request][prs] and add it here!

Issues

Looking to contribute? Look for the [Good First Issue][good-first-issue] label.

🐛 Bugs

Please file an issue for bugs, missing documentation, or unexpected behavior.

[See Bugs][bugs]

💡 Feature Requests

Please file an issue to suggest new features. Vote on feature requests by adding a 👍. This helps maintainers prioritize what to work on.

[See Feature Requests][requests]

Contributors ✨

Thanks goes to these people ([emoji key][emojis]):


Kent C. Dodds

💻 📖 🚇 ⚠️

Carl Rosell

🤔

Phil Hawksworth

🤔

Matt Ferderer

📖

Jed Fox

💡

Eric McCormick

📖

Preston Lamb

💻

Daniel D. Beck

📖

Justin Dorfman

🔍

Jake Jarvis

💻

Michaël De Boey

💻

Oisín Quinn

💻 ⚠️

SebJones

💻

This project follows the [all-contributors][all-contributors] specification. Contributions of any kind welcome!

LICENSE

MIT

[npm]: https://www.npmjs.com/ [node]: https://nodejs.org [build-badge]: https://img.shields.io/travis/kentcdodds/netlify-shortener.svg?style=flat-square [build]: https://travis-ci.org/kentcdodds/netlify-shortener [coverage-badge]: https://img.shields.io/codecov/c/github/kentcdodds/netlify-shortener.svg?style=flat-square [coverage]: https://codecov.io/github/kentcdodds/netlify-shortener [version-badge]: https://img.shields.io/npm/v/netlify-shortener.svg?style=flat-square [package]: https://www.npmjs.com/package/netlify-shortener [downloads-badge]: https://img.shields.io/npm/dm/netlify-shortener.svg?style=flat-square [npmtrends]: http://www.npmtrends.com/netlify-shortener [license-badge]: https://img.shields.io/npm/l/netlify-shortener.svg?style=flat-square [license]: https://github.com/kentcdodds/netlify-shortener/blob/master/LICENSE [prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square [prs]: http://makeapullrequest.com [coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square [coc]: https://github.com/kentcdodds/netlify-shortener/blob/master/other/CODE_OF_CONDUCT.md [emojis]: https://github.com/all-contributors/all-contributors#emoji-key [all-contributors]: https://github.com/all-contributors/all-contributors [bugs]: https://github.com/kentcdodds/netlify-shortener/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Acreated-desc+label%3Abug [requests]: https://github.com/kentcdodds/netlify-shortener/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3Aenhancement [good-first-issue]: https://github.com/kentcdodds/netlify-shortener/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3Aenhancement+label%3A%22good+first+issue%22
RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free