Skip to content

Latest commit

 

History

History
114 lines (71 loc) · 4.79 KB

README.md

File metadata and controls

114 lines (71 loc) · 4.79 KB

URL Shortener

A SpringBoot project which shortens URLs and redirects short URLs to the origin


Report Bug

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage

About The Project

As already many services are available, e.g. bit.ly, to create short URLs this project is yet another service which implemented by using the Kotlin programming language and provides identical functionality

Built With

(back to top)

Getting Started

The following steps give instructions on setting up the project locally. As the application is a simple SpringBoot app you can run it as well on your cloud environments and deploy it there.

Prerequisites

Define port and the URL of your website

  • application.properties file 
    server.port=8080
base_url=localhost:8080

Installation

  1. Clone the repo 
    git clone https://github.com/rhaeckl/url-shortener-app.git
  2. Run the SpringBoot application

(back to top)

Usage

How the application can be used is documented in the Swagger UI which can be found here:

http://localhost:8080/swagger-ui

Contact

Robert Häckl - [email protected]

Project Link: https://github.com/rhaeckl/url-shortener-app

(back to top)

(back to top)