URL Shortener

This is a URL shortener webapp.

---

Functionality

1. User can retrieve a shortened URL by providing a standard URL
2. User can copy the short url, paste it into the browser URL bar, hit enter, and get to the same URL they have shortened it from

---

Tech Stack

Backend: Django Rest Framework, PostgreSQL Frontend: React, MaterialUI

see here for API Documentation

---

Requirements

Ensure that Docker is installed in your OS: https://docs.docker.com/get-docker/

To start

Clone the git repository: git clone https://github.com/raywtham/url-shortener.git

RUN in terminal: docker compose up

To use

Navigate to http://localhost:3000/ in browser to use the webapp

To shut down

ctrl-c in running terminal

Made by Ray Tham