npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

get-shorty

v0.1.0

Published

Add a URL shortening service to any Express.js app using Shorty middleware

Downloads

5

Readme

Shorty

Shorty

Integrate a URL shortening service into any Express.js app using Shorty middleware.

Requirements

  • An Express.js app with express.bodyParser() included above Shorty in the middleware stack
  • Mongoose

Getting Started

Simply require Shorty as part of your Express.js middleware stack passing in the necessary configuration options.

$ npm install get-shorty

var express = require("express"),
    http = require("http"),
    app = express(),
    mongoose = require("mongoose"),
    Shorty = require("get-shorty");

mongoose.connect("mongodb://localhost/your_db");

app.use(express.bodyParser());
app.use(Shorty());

http.createServer(app).listen(1337);

Using Shorty

Creating a Shortened URL

To create a shortened URL, simply POST a JSON object to your Shorty path (default http://your-hostname.com/shorty) with your URL set as the "URI" property. For example,

{
	"uri": "http://news.ycombinator.com"
}

Accessing a Shortened URL

Visit the shorty path with the given alias and you will be redirected to the stored URL (e.g. http://your-hostname.com/shorty/1dDqd)

Configuration Options

To configure Shorty, pass a configuration object with one or more of the following properties

  • path The route at where the Shorty middleware will reside (default: "shorty")
  • urlLifespan Time to live for each shortened URL created in seconds (default: Links do not expire)
  • collectionName The name of the collection that will store your shortened URLs in MongoDB (default: "Shorty")
  • aliasLength Determines the character length for the alias of each shortened URL (default: 5)

For example,

app.use(Shorty({
	path: "urls",
	urlLifeSpan: 604800 		// Redirects expire after a week
	aliasLength: 2					// Aliases will be 2 characters in length
}));

// Example redirect path

http://your-hostname.com/urls/1D 

License

MIT

Contributions are welcome