Shorty

A URL shortener written in Go

Getting Started

Run shorty by using docker-compose or by building a docker image. Shorty binds to port 3000 by default.

Docker Compose

docker-compose up

Creating and running a docker container

docker build -t shorty:latest .
docker run --name shorty_web_1 -p 3000:3000 -it shorty:latest

# After shutting down the docker container use the following command to start it
docker start -i shorty_web_1

Routes

POST localhost:3000/new

Create a post request to localhost:3000/new to creates a new short URL associated with the specified user. If the user id does not exist, it is added.

Request

{
  "user_id": 1,
  "url": "https://example.com"
}

Response

{
  "short_url": "http://localhost:3000/abcdef"
}

GET localhost:3000/shortcode

Accessing the returned short URL redirects to its original long URL.

Directory Structure

shorty/
  cmd/
    shorty/ # Home of the executable

  handler/ # The request handler for the server. It creates
           # and resolves short url codes through a datastore
           # member of its struct.

  in-memory/ # An in memory implementation of the datastore
             # interface

  mocks/ # The github.com/vektra/mockery generated mocks

  rand/ # A helper package to generate random short url codes

  datastore.go # The interface for creating new short urls
               # and resolving short urls to their original
               # url

  url.go  # Models for storing the short url code and user
  user.go # information in the datastore.

countingtoten/shorty