Uses netlify's redirect functionality to make a personal URL shortener. Works beautifully :)
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 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.
This module is distributed via npm which is bundled with node and
should be installed as one of your project's dependencies:
npm install --save netlify-shortener
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 homepage to your package.json:
{
"homepage": "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:
- generates a short code if one is not provided
- validates your URL is a real URL
- adds the URL to the top of
_redirects - runs a git commit and push (this will trigger netlify to deploy your new redirect)
- 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.
If you want to be able to run this anywhere in the terminal, you can try making a custom function for your shell.
- Add the following executable definition to your
package.json:{"bin": {"shorten": "cli.js"}} - Create the
cli.jsfile:#!/usr/bin/env node require('netlify-shortener')
- From your project directory, run the following to register the command
globally:
npm link
You can use this script with ScriptKit which integrates with netlify-shortener as well.
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.
- netlify-shortener-sh: plain shell script version
If you know more alternatives, please make a pull request and add it here!
Looking to contribute? Look for the Good First Issue label.
Please file an issue for bugs, missing documentation, or unexpected behavior.
Please file an issue to suggest new features. Vote on feature requests by adding a 👍. This helps maintainers prioritize what to work on.
Thanks goes to these people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
MIT