LearnBoost URL shortening/redirection service.
JavaScript HTML CSS
Switch branches/tags
Nothing to show
Latest commit 10b604a Aug 21, 2013 @ForbesLindesay ForbesLindesay committed with TooTallNate package: add "repository" field
Closes #7.

README.md

Shorty

Shorty is LearnBoost's URL shortening/redirection service.

Features

  • Redis backed
  • Super fast
  • At production use on https://lrn.cc
  • Uses express, jade, stylus. Easy to hack on!
  • Realtime stats with socket.io

Client API

Post to / with the url field to create.

  • If a field is missing or incorrect, status 400 is returned with a JSON body (error key)
  • If a problem saving the URL occurs, a status 500 is returned.
  • If the url is created, status 200 is returned with JSON body (short key)
  • If the url already exists, same response as creation is returned.

Config

To set the short URL to include in JSON responses set the env var SHORTY_DOMAIN to your hostname (e.g.: lrn.cc)

If not running redis on localhost, set SHORTY_REDIS_PORT and SHORTY_REDIS_HOST pointing to your redis instance.

Examples

Using curl:

$ curl -X POST -d "url=http://www.learnboost.com" https://lrn.cc/

Credits

(The MIT License)

Copyright (c) 2011 Guillermo Rauch <guillermo@learnboost.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

3rd-party