Skip to content

Latest commit

 

History

History
31 lines (16 loc) · 670 Bytes

README.md

File metadata and controls

31 lines (16 loc) · 670 Bytes

URLShortener

Public url shortener

Build Status

Simple url shortener API

Docs

I would advise you to interact with the API through the cli tool shorten-cli.

See https://github.com/martolini/shorten-cli

API Reference: https://urlshortener.surge.sh

Run locally

$ yarn #install packages

$ yarn test #run tests once

$ yarn test:watch #watch tests

$ yarn watch #run and restart on changes

Environment variables

BASE_URL -- Base url that gets returned from POST /shorten.

PORT -- port that the server is listening to.