Skip to content

pranjul-dev/Url-Shortener

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 

Repository files navigation

🔗 Tiny Link - URL Shortener

A full-stack MERN application for shortening URLs with user authentication, analytics, and QR code generation.

Tiny Link Screenshot

✨ Features

  • User Authentication: Secure login/signup with JWT
  • URL Shortening: Generate short URLs with unique IDs or custom aliases
  • Analytics: Track click counts and view statistics
  • QR Codes: Generate and download QR codes for any URL
  • Social Sharing: Share links on multiple platforms
  • Responsive Design: Works on all devices

🛠️ Tech Stack

  • Frontend: React, Tailwind CSS, Hero UI
  • Backend: Node.js, Express
  • Database: MongoDB
  • Authentication: JWT
  • QR Generation: react-qr-code

🚀 Quick Start

Prerequisites

  • Node.js v14+
  • MongoDB (Atlas or local)
  • npm or yarn

Installation

  1. Clone the repository:
git clone https://github.com/pranjul-dev/Url-Shortener
cd tiny-link
  1. Set up the backend:
cd server
npm install
  1. Create .env file in server directory:
MONGO_URI=your_mongodb_connection_string
JWT_SECRET=your_jwt_secret_key
PORT=8080
  1. Set up the frontend:
cd ../client
npm install
npm run build

Running the Application

cd ../server
npm start

The app will be available at http://localhost:8080

⚙️ Configuration

Environment Variable Description Required
MONGO_URI MongoDB connection string Yes
JWT_SECRET Secret for JWT tokens Yes
PORT Server port (default: 8080) No

📂 Project Structure

tiny-link/
├── client/          # React frontend
│   ├── public/
│   └── src/
├── server/          # Express backend
│   ├── controllers/
|   ├── middlewares/
│   ├── models/
│   ├── routes/
│   └── utils/
└── README.md

🤝 Contributing

Pull requests are welcome. For major changes, please open an issue first.

About

A URL shortener web application built using the MERN stack—MongoDB, Express.js, React, and Node.js—that converts long URLs into short, shareable links.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors