https://github.com/pyrocat101/shorturl

URL shortener in Node.js
https://github.com/pyrocat101/shorturl

Last synced: about 1 month ago
JSON representation

URL shortener in Node.js

• Host: GitHub
• URL: https://github.com/pyrocat101/shorturl
• Owner: pyrocat101
• Created: 2012-03-08T14:13:24.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2012-03-09T16:50:58.000Z (almost 13 years ago)
• Last Synced: 2024-10-14T18:59:08.989Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 211 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# URL Shortener

This is a simple URL shortener written in CoffeeScript and Jade template language. It uses Redis for data storage.

# How to use

* Install dependencies

    `npm install`

* Check the configuration

    By default, URL shortener app assumes [redis-server](http://redis.io/) at ```localhost:6379```. However, it can be easily changed to other hosts or ports in `app.coffee`.

    Besides, the service is running at port `3000`. You should change it to others to suit your needs.

* Run the service

    The server-side is fully written in [CoffeeScript](http://coffeescript.org/). Run the server from coffee-script command-line:

    

    `coffee app`

    Compile scripts is another alternative:

    ```

    coffee -c *.coffee

    node app

    ```

# API

The URL shortener also provides an API to retrieve short URLs for abitrary long URLs. See the index page on dev server for further description.