A modern, minimalist, and lightweight URL shortener using Node.js and Redis
Branch: master
Clone or download
Pull request Compare This branch is 4 commits ahead, 35 commits behind dotzero:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
lib
public
routes
test
views
.editorconfig
.gitignore
.travis.yml
LICENSE
README.md
app.js
package.json

README.md

Node Url Shortener

A modern, minimalist, and lightweight URL shortener using Node.js and Redis.

Build Status GitHub tag Dependency Status

Using

Quick Start

$ git clone https://github.com/fadeit/node-url-shortener nus
$ cd nus
$ npm install
$ node app

Command Line Options

$ node app -h

Usage: app [options]

Options:
  -u, --url     Application URL               [default: "http://127.0.0.1:3000"]
  -p, --port    Port number for the Express application          [default: 3000]
  --redis-host  Redis Server hostname                     [default: "localhost"]
  --redis-port  Redis Server port number                         [default: 6379]
  --redis-pass  Redis Server password                           [default: false]
  -h, --help    Show help                                              [boolean]

Installation on production

$ git clone https://github.com/fadeit/node-url-shortener nus
$ cd nus
$ npm install --production
$ NODE_ENV=production cd /path/to/nus && /usr/bin/forever start app.js --port 8000 --domain https://your.domain

Tests

To run the test suite, first install the dependencies, then run npm test:

$ npm install
$ npm test

License

Released under the MIT license