npathai / system-design-with-code

System design not just on whiteboard, but with code.

system-design-with-code 💻

System design not just on whiteboard, but with code.

Why this repository?

This repository represents an effort to learn System Design by experimenting, failing-fast, learning from that experince and providing all the fellow developers a wealth of knowledge in terms of source code.

System design always seemed quiet far from reach because the knowledge available online either is too shallow or basic, or quiet high level. Being a developer, I wanted to learn by looking at code and experimenting. Facing challenges head on and building robust systems. If you feel the same, then this repository is perfect for you!

Goals

Try to re-create system design case studies, not just on prototype scale but full scale. I intend to deploy sytems on cloud and load test them at scale.

All systems built in this repository should be

• Microservices driven (or even Serverless)
• Lightweight
• Highly scalable
• Fault tolerant (kill machines randomly and system shouldn't cave in)
  • No single point of failure
• High performance
• Observable and Traceable

Projects

URL Shortening Service

Chatter (Slack) - Inspired from Mattermost

Discourse (QnA)

BookMyShow

Technology Stack

1. Micronaut Framework
2. Zookeeper
3. Consul Service Discovery
4. MySQL
5. Redis Cache
6. Test Containers
7. React (frontend)
8. Docker
9. Zipkin
10. Hystrix/Resilience4J
11. Micrometer
12. Prometheus
13. Grafana
14. Gatling

system-design-with-code's Issues

Decide on discussion platform

• Slack
• Discord
• Discourse

Twitter

Create a twitter like service

IRCTC (Train Reservation)/RedBus

Create an IRCTC type service

Leetcode

Create Leetcode type service, specifically the code execution and verification aspect.

Typeahead Suggestion

Create typeahead suggestion engine

WhatsApp Messenger

Create WhatsApp messenger like service, where history is maintained in client device. Undelivered messages are kept in cloud.

Google Docs

Create Google Docs type service, which allows basic collaboration writing feature

Facebook Messenger

Design Facebook messenger like service. Message history is maintained in cloud.

Pastebin

Paste and share service
https://pastebin.com/

Url Shortening Service

• From long url to short url
• From short to long url
  • Basic conversion
  • Who should append the hostname in short url
  • Considerations for load balancing
  • What if there are multiple hostnames
• Redirect the user to long url when short url is visited
• Url expiry
• User Authentication
  • Basic authentication or OpenId Connect
  • Authenticated User will get Analytics and Tracking
  • Without authentication create url with default expiry maybe a week
  • Delete url
• Add Documentation
• Add logging (include user IP for tracking and analytics)
• short-url-gen service should only be accessible using public network, id-gen-service etc should not be directly reachable from outside network.
• Distributed tracing with Zipkin

Add read me files for every system design solution

@npathai I would recommend adding read me files to each use case. It would help readers understand code and flow of solution,

Wunderlist/Microsoft Todo

Create a todo application

Instagram

Creating Instagram like service

Web Crawler

Create a Web Crawler

Badge generator service

A neat simple service for generating badges for Github Readme pages.
https://badgen.net/

API Rate Limiter

Create API rate limiter type service

Slack

Reddit

YouTube or Netflix

Create YouTube or Netflix like service

Dropbox

Create Dropbox, Google Drive or One drive like service

Fandango/Bookmyshow

Create Fandango or BookMyShow type service