Skip to content

Latest commit

 

History

History
65 lines (45 loc) · 2 KB

README.md

File metadata and controls

65 lines (45 loc) · 2 KB

Chotu : URL Shortner

Contents

  1. Overview
  2. Basic Architecture
  3. Setup
  4. Demo
  5. Routes Used
  6. TODO

Overview

  • This Web App is made to understand underlying funtionality of URL Shortner sevices from prototying to scalabilty point of view.
  • Watch this system design Youtube video for proper understanding of system
  • Tech stack used : Bootsrap, NodeJS, MongoDB, ExpressJS, nanoid
  • Work on progress.

Basic Architecture

Architecture

Setup

Before proceeding please download and install NodeJS and MongoDB because it is required.

  1. Download/Clone the Repository
  2. Navigate into the Repository folder on your disk using Terminal
  3. Make sure that you have the Node and MongoDB installed
  4. Run the following command to run the setup,npm install
    Now everything required should be installed, go ahead and run the following command whenever you want to run the app, node index.js
The App would now be Up and Running on localhost:6700

Demo

Web App

Routes

Route Description Signature
/shorturl (post) Takes full URL as input Body: { url}
/:url (get) pass shorturl as paramater Body: { shorturl

TODO ☑

  • Basic prototyping
  • Copy to Clipboard
  • Custom Naming
  • Expiration period
  • Add Redis for caching
  • Changing short code algorithm and check duplicate short codes
  • Make scalable