Shorty URL

A modern, fast, and secure URL shortening service

• 🔗 URL Shortening — Create short, memorable links instantly
• 📱 QR Code Generation — Download QR codes for any shortened link
• 📊 Link Analytics — Track clicks, unique visitors, and performance
• 🌙 Dark Mode — Beautiful light and dark themes
• 🔒 Secure — HTTPS-only validation, rate limiting, and input sanitization
• 📝 Link History — Local storage-based history of your created links
• 🚨 Report System — Report suspicious or malicious links
• 📧 Contact Form — Built-in contact functionality
• 📱 Responsive — Works perfectly on desktop and mobile

• Frontend: https://shorty.msyb.dev

url-shorty/
├── frontend/                 # React frontend application
│   ├── public/              # Static assets (logo, manifest, etc.)
│   └── src/
│       ├── pages/           # Page components (Home, Contact, Report, etc.)
│       ├── Components/      # Reusable components
│       ├── context/         # React context (Theme)
│       ├── services/        # API service layer
│       ├── App.js           # Main app with routing
│       └── App.css          # Global styles
│
├── server/                   # Express backend API
│   ├── scripts/             # Database initialization scripts
│   └── src/
│       ├── config/          # Database & app configuration
│       ├── controllers/     # Request handlers
│       ├── middlewares/     # Security, validation, rate limiting
│       ├── models/          # Database models
│       ├── routes/          # API route definitions
│       └── utils/           # Helper functions & logger
│
└── README.md                 # This file

• Node.js 18+ (LTS recommended)
• MySQL 8.0+ (or compatible: MariaDB, PlanetScale, etc.)
• npm or yarn

git clone https://github.com/shehari007/url-shorty.git
cd url-shorty

cd server

# Install dependencies
npm install

# Configure environment
cp .env.example .env
# Edit .env with your database credentials

# Initialize database (creates all tables)
npm run db:init

# Start development server
npm run dev

cd frontend

# Install dependencies
npm install

# Start development server
npm start

The frontend will be available at http://localhost:3000 and the API at http://localhost:8080.

• Helmet.js — Secure HTTP headers
• Rate Limiting — Prevent API abuse
• Input Validation — Sanitize all user inputs
• SQL Injection Protection — Parameterized queries
• XSS Protection — Content sanitization
• CORS — Configurable origin whitelist
• HTTPS Validation — Only secure URLs accepted

Run npm run db:init in the server directory to create all tables automatically.

Both frontend and server are configured for Vercel deployment:

1. Connect your GitHub repository to Vercel
2. Set environment variables in Vercel dashboard
3. Deploy!

# Frontend
cd frontend
npm run build
# Deploy the 'build' folder to your hosting

# Server
cd server
npm start

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

This project is licensed under the MIT License - see the LICENSE file for details.

shehari007

• GitHub: @shehari007