Git Product home page Git Product logo

url-shortener's Introduction

url-shortener

Shortens links using Spring Boot + ReactJS

Installation

git clone git://github.com/ybutrameev/url-shortener.git
cd url-shortener
mvn clean install

You will also need redis-server to use this project

Then look up to your target folder to experience new born lv-1.0-SNAPSHOT.jar
You can simply run java -jar lv-1.0-SNAPSHOT.jar at that point
Web interface will be available at localhost:8080

REST API endpoints

shorten POST

http://localhost:8080/api/shorten

Consumes a link and optional custom id. Id's max size is 12 symbols.

{
  "url": "https://github.com",
  "customId": null
}

Returns:

{
  "shortUrl": "http://localhost:8080/r/baTo"
}

get GET

http://localhost:8080/api/get/{id}

Returns a long link consuming id as a path variable:

{
  "longUrl": "http://github.com"
}

count GET

http://localhost:8080/api/count

Returns a number of already shortened links:

{
  "urlCount": "29381"
}

Error case

API error format:

{
  "timestamp": "2018-12-12T15:55:55.059+0000",
  "status": 400,
  "error": "Bad Request",
  "message": "Custom Id is already used",
  "path": "/api/shorten"
}

Tests

This project uses JUnit4 to test REST API endpoints.
Tests are located at src/test/java

Front-end screenshot

Alt text
Links counter is animated ^_^ (trust me)

url-shortener's People

Contributors

ybutrameev avatar

Stargazers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.