punitpatel214 / baby-url-generator Goto Github PK

URL shortening is used to create shorter aliases for long URLs. We call these shortened aliases “short links.” Users are redirected to the original URL when they hit these short links. Short links save a lot of space when displayed, printed, messaged, or tweeted. Additionally, users are less likely to mistype shorter URL

License: Apache License 2.0

Java 68.67% HTML 2.08% CSS 12.88% JavaScript 15.35% Shell 0.05% Dockerfile 0.97%

system-design software-architecture software-design microservice architecture-decision-records architecture shorturl-services tinyurl-service

baby-url-generator's Introduction

Baby-Url-Generator

This repository is for learning system design, system design implementation not only with diagrams but also with end to end implementation with best practices.

Live Application: https://baby-ui-punitpatel214.cloud.okteto.net/

Overview

Baby URL Generator creates shorter url for long URLs. We call these shortened url “baby links.” Users redirect to the original URL when they hit these baby link. Baby links save a lot of space when displayed, printed, messaged, or tweeted. Additionally, users are less likely to mistype shorter URL.

User

thousands, one day millions

Requirements

Create portal for baby url generator, User generate baby url from long url. User will redirect to original URL when they hit baby url.
User can share baby link through Social Media. In future user can create QR code for baby link.
Baby url should not be guessable.
User can see all created baby link and can delete baby link. User can change long url.
Guest User also can generate baby link.

baby-url-generator's People

Contributors

Watchers

Forkers

ankitbhavsar

baby-url-generator's Issues

First release of application

deploy release-0 for application

add security configurations for kubernetes pod

add username and password in Cassandra deployment
add username and password in Redis deployment
add API key in baby UI
key generator service not exposed outside

Sonar Integration in project

Integrate sonar cloud with project, also integrate it with GitHub action

Also, resolve sonar code smell

BenchMark Performance of Redis, Memcache and Hazelcast

Redis, Memcache, and Hazelcast all provide cache solutions. Execute performance tests and benchmarks with each solution. So, we have performance stats for each cache solution.

Based on Performance stats we may change the cache solution.

configure gitleak scan for repository

Gitleaks is a SAST tool for detecting and preventing hardcoded secrets like passwords, api keys, and tokens in git repos. Gitleaks is an easy-to-use, all-in-one solution for detecting secrets, past or present, in your code.
refer for more information.

integrate gitleak in repository

Create High level and Low level Design diagram

use draw.io
explore https://www.structurizr.com/

add Kubernetes config file and test it on minikube

add Kubernetes config file for each service
end to end test it on minikube

Puzzlers

List down problems face while implementing the project

TestPropertyProvider in Micronaut does not support List value support, For Test Instance in micronaut we can configure the test property of Map<String, String>. But It has no support for LIst. Need to investigate it. Currently, resolve this issue by using Map without generic parameters. -> ask question
In CI some Mock tests are working on local but not working on CI. Still don't know why this happens. Currently,fix these tests by adding eq mockito matcher in argument. [See]( https://github.com/punitpatel214/baby-url-generator/blob/master/url-shortener/src/test/java/com/babyurl/urlshortener/resolver/BaseURLRedirectionUrlResolverTest.java l)