url-shortener

A tiny utility to short long URLs

Installation

Requirements

• Node.js (min. LTS)
• npm
• Git

Installation

We only provide a Docker image for installation. Make sure you are familiar with Docker.

Docker

When you already have an existing Database, you can use the Dockerfile/Image to create a new container.

You can pull the prebuild image from Docker Hub

docker pull ledbrain/url-shortener

Docker Compose

To use the compose file, clone the repo, configure the docker-compose.yml and then do:

docker-compose up -d

To stop it, use

docker-compose down

API Documentation

See in API.md

Contributors ✨

Thanks goes to these wonderful people (emoji key):

naton 📦

This project follows the all-contributors specification. Contributions of any kind welcome!