https://github.com/tyler-johnson/shorturl

A URL shortening service powered by Node.js and Redis
https://github.com/tyler-johnson/shorturl

Last synced: 5 days ago
JSON representation

A URL shortening service powered by Node.js and Redis

• Host: GitHub
• URL: https://github.com/tyler-johnson/shorturl
• Owner: tyler-johnson
• License: mit
• Created: 2015-02-01T21:38:31.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2017-05-01T15:35:54.000Z (over 7 years ago)
• Last Synced: 2024-04-25T15:42:45.296Z (7 months ago)
• Language: JavaScript
• Homepage: http://yuk.nu
• Size: 526 KB
• Stars: 10
• Watchers: 5
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - tyler-johnson/shorturl - A URL shortening service powered by Node.js and Redis (others)

README

        
# URL Shortener Service

[![npm](https://img.shields.io/npm/v/@mrgalaxy/shorturl.svg)](https://www.npmjs.com/package/@mrgalaxy/shorturl) [![Build Status](https://travis-ci.org/tyler-johnson/shorturl.svg?branch=master)](https://travis-ci.org/tyler-johnson/shorturl)

This is the source code for my URL shortener. I made it as an experiment to see how URL shorteners work under the hood. The source is licensed under MIT so feel free to hack away!

Check out the live version: 

### Install

Install globally using NPM.

```bash

npm i @mrgalaxy/shorturl -g

```

Check that the tool was installed correctly.

```bash

shorturl-server --help

```

### Usage

To run a local server, ensure a local [Redis server](https://redis.io) has been started at the default port. Then run the following command:

```bash

shorturl-server

```

This will start a local server at .