@rockymadden/now-go

now-go

A personal tinyurl service.

Now go, let the legend come back to life!

Features

• Lightweight tinyurl service (in 100 lines).
• Semi-auto update with a remote config.
• Three types of routes:
  • redirect to an url
  • echo a string
  • proxy tunnel

Quick Start

• cli

  now-go -c path/to/config.json
  

• programaticly

  import nowgo from 'now-go'
  
  nowgo('./config.json')
  

Here is an example repo you can deploy to now.sh in 1 minute.

If you don't have now yet, npm install -g now. Don't miss this awesome tool for realtime global deployments.

The config.json

All configurations are optional:

{
  "routes": {
    // redirection (<value> is a url)
    "home": "https://github.com/amio/now-go",
    // proxy mode (<value> is a url prefixed with "PROXY >> ")
    "ocelot.jpg": "PROXY >> https://example.com/path-to-ocelog.jpg",
    // echo a string (<value> is a string)
    "now-go": "Now go, let the legend come back to life!",

    // special route for root path (<key> === "/")
    "/": "Yet another tinyurl service.",
    // special route for unmatched path: (<key> === "?")
    "?": "What are you looking for"
  },
  "port": 3030 // optional, 3000 by default
}

This is the config powers http://go.now.sh, go try it. (While, maybe not exactly the full latest version)

Remote Config

• Instead of now-go -c config.json, start server with:

now-go -c https://example.com/path-to-config.json

• Visit root path(the sepcial route "/") will trigger an update task in background -- so called "semi-auto update" :)

License

MIT © Amio