https://github.com/hokamc/shorten-url-demo

A demonstration of shorten url, that built with Java (core-ng, spring boot) and rust (actix-web), includes CICD and Kubernetes to automate workflow.
https://github.com/hokamc/shorten-url-demo

actix-web cicd core-ng github-actions java kubernetes redis rust shorten-urls spring-boot system-design

Last synced: about 22 hours ago
JSON representation

A demonstration of shorten url, that built with Java (core-ng, spring boot) and rust (actix-web), includes CICD and Kubernetes to automate workflow.

• Host: GitHub
• URL: https://github.com/hokamc/shorten-url-demo
• Owner: hokamc
• Created: 2020-07-29T08:39:09.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-01-28T05:57:21.000Z (almost 3 years ago)
• Last Synced: 2024-12-19T20:39:25.380Z (9 days ago)
• Topics: actix-web, cicd, core-ng, github-actions, java, kubernetes, redis, rust, shorten-urls, spring-boot, system-design
• Language: Java
• Homepage:
• Size: 151 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  

 



Shorten Url Demo




[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)]()

[![Status](https://img.shields.io/badge/status-active-success.svg)]()



 A complete shorten url application

    
 



## Table of Contents

- [Table of Contents](#table-of-contents)

- [Demo](#demo)

- [Features](#features)

- [Design](#design)

- [Limitation](#limitation)

- [Redis](#redis)

- [CI/CD](#CI/CD)

- [Kubernetes](#kubernetes)

- [Core-ng](#core-ng)

- [Spring Boot](#spring-boot)

- [Actix-web](#actix-web)

- [Authors](#authors)

## Demo

Let's play!

https://shorturl.hokamc.work

## Features

- Add shorten url

- IP limiting (5 call for 1 hour)

- Redirect shorten url

## Design

Use a distributed counter to encode the url to prevent duplicated url, and use a map to save all encoded and decoded url to fast look up.

The whole design is for simplicity only, many other concerns like partitions, high available, CDN and more should be considered before production.

## Limitation

- Non random url

- Single redis can only have 2^32 keys, so may need partitions design

- Single counter may become bottleneck

## Statistic

Suppose we allow 6 characters only, there will be 62^6 (56800235584) possibles combinations for encoded url.

- HashTable for lookup: 62^6 * (2048 + 6) ~= 107 TB (*2048 longest url)

## Analysis

Randomness

- Pre-generated combinations (Need large resource)

- Hash the url (Need conflict resolve)

Scalable

- Use a scalable database instead of redis, better for partitioning, persistent and replication

- A proper setup for CDN can reduce load from your application to CDN network

## Redis

- Cache for shorten url mapping

- Cache for ip

- Safe incremental counter

## CI/CD

I use Github action for CI. Major steps are building java, building image and push to registry.

You can check the image from [hokamc/packages/shorten-url-demo](https://github.com/users/hokamc/packages/container/package/shorten-url-demo)

## Kubernetes

A statefulset for redis and a deployment for app which is easy to scale up.

## Core-ng

## Spring Boot

## Actix-web

## Authors

- [@hokamc](https://github.com/hokamc)