https://github.com/05sanjaykumar/url-shortern
A scalable, Dockerized URL Shortener built with Node.js and Redis — designed to explore backend architecture, caching, and deployment concepts.
https://github.com/05sanjaykumar/url-shortern
devops docker express express-js nginx node redis url-shortener
Last synced: 2 months ago
JSON representation
A scalable, Dockerized URL Shortener built with Node.js and Redis — designed to explore backend architecture, caching, and deployment concepts.
- Host: GitHub
- URL: https://github.com/05sanjaykumar/url-shortern
- Owner: 05sanjaykumar
- Created: 2025-05-05T17:35:32.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-13T19:55:52.000Z (about 1 year ago)
- Last Synced: 2025-05-13T20:55:06.004Z (about 1 year ago)
- Topics: devops, docker, express, express-js, nginx, node, redis, url-shortener
- Language: JavaScript
- Homepage:
- Size: 113 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🔗 URL Shortener
A full-stack, production-grade URL shortening service built with **Node.js**, **Express**, **Redis**, and **Docker** — complete with rate limiting, RESTful API, unit tests, and deployment on Render.
---
## 🌍 Live Demo
> 🟢 Deployed on [Render](https://url-shortern-9qxj.onrender.com/)
> Frontend: Static `HTML + JS`
> Backend: Node.js + Redis
> Dockerized with `Dockerfile` and `nginx` (for local use)
---
## 🧰 Tech Stack
- **Frontend**: HTML, JavaScript (Vanilla)
- **Backend**: Node.js + Express
- **Database**: Redis (for storing shortened URLs)
- **Testing**: Jest
- **Rate Limiting**: Custom Express middleware
- **DevOps**:
- Docker & docker-compose (for local setup)
- Render (for cloud deployment)
- NGINX (proxy for containerized routing)
---
## 📁 Project Structure
```
├── public/ # Static frontend
├── src/
│ ├── controllers/ # Shorten & redirect logic
│ ├── routes/ # API endpoints
│ ├── services/ # Redis + URL generation
│ └── middleware/ # Rate limiter
├── test/ # Unit tests (with mocks)
├── Dockerfile # Container setup
├── docker-compose.yml # Dev orchestration
├── server.js # Entry point
├── README.md # Project info
````
---
## ✅ Features
- 🔗 Shortens long URLs to 6-character codes
- 🚀 Redirects to original URL from code
- 🧠 Stores data in **Redis**
- 🛡️ Built-in **rate limiter** middleware (basic DDoS protection)
- 🧪 Unit tested with mocks for Redis
- 🐳 Local Docker support
- 🌐 Deployed on **Render**
---
## 🚀 Running Locally
### Option 1: Docker (Recommended for full stack)
```bash
docker-compose up
````
### Option 2: Manual
```bash
npm install
redis-server
npm start
```
Then visit: [http://localhost:3000](http://localhost:3000)
---
## 🧪 Run Tests
```bash
npm test
```
Includes mocks for Redis to ensure unit isolation.
---
## 🌐 Deployment (Render)
The backend and frontend are deployed using **Render.com**:
* **Backend**: Connected to Redis instance
* **Frontend**: Served via static files or nginx
* **Base URL** is set dynamically in production
---
## 📌 Learnings
* 📦 **Modular Express structure** with `controllers`, `routes`, and `services`
* 🧪 Wrote **unit tests** with Redis mocks
* 🐳 Learned how to containerize full-stack apps with Docker
* 🚀 Deployed using **Render** and explored cloud hosting
* 🛡️ Implemented basic **rate limiting**
* 🌱 Explored logging, monitoring, and optional CI/CD pipelines
---
## 🙌 Author
**Sanjay Kumar** — *Lifelong learner, Polyglot dev, and builder of things.*