garthoff / boilerplate-project-urlshortener

A boilerplate for a freeCodeCamp project.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

API Project: URL Shortener Microservice for freeCodeCamp

User Stories

  1. I can POST a URL to [project_url]/api/shorturl/new and I will receive a shortened URL in the JSON response. Example : {"original_url":"","short_url":1}
  2. If I pass an invalid URL that doesn't follow the valid http(s):// format, the JSON response will contain an error like {"error":"invalid URL"}. HINT: to be sure that the submitted url points to a valid site you can use the function dns.lookup(host, cb) from the dns core module.
  3. When I visit the shortened URL, it will redirect me to my original link.

Creation Example:

POST [project_url]/api/shorturl/new - body (urlencoded) : url=



Will redirect to:


A boilerplate for a freeCodeCamp project.


Language:HTML 55.9%Language:CSS 23.5%Language:JavaScript 20.5%