Skip to content

Zortex-Tech-Solutions/Short-ly-URL-Shortener

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

2 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Short.ly - URL Shortener with Analytics

Short.ly Banner React License

A sleek, modern URL shortener application with comprehensive analytics tracking. Built with React and featuring a beautiful black and grey design, Short.ly makes it easy to create, manage, and analyze your shortened URLs.

✨ Features

Core Functionality

  • URL Shortening - Convert long URLs into short, shareable links
  • Custom Aliases - Create memorable custom short URLs (e.g., short.ly/my-link)
  • Persistent Storage - All data is saved locally and persists between sessions
  • QR Code Generation - Generate scannable QR codes for any shortened URL

Management Tools

  • Title/Labels - Assign custom titles to organize your URLs
  • Edit Titles - Update URL titles after creation
  • Delete URLs - Remove URLs you no longer need
  • Search & Filter - Quickly find URLs by title, long URL, or short code
  • Date Filtering - Filter URLs by creation date (today, this week, this month, all time)
  • Export Data - Download all your URLs as JSON for backup or analysis

Analytics Dashboard

  • Total URLs - Track how many URLs you've created
  • Total Clicks - See cumulative click counts across all URLs
  • Clicks Today - Monitor recent engagement
  • Average Clicks - Understand typical URL performance
  • Top Performing URLs - View your top 10 most-clicked links
  • Recent Activity - See the latest 5 clicked URLs with timestamps
  • Click History - Detailed tracking of when each URL was accessed

πŸš€ Getting Started

Prerequisites

  • Node.js (v14 or higher)
  • npm or yarn package manager

Installation

  1. Clone the repository
git clone https://github.com/SYOP200/short-ly-url-shortener.git
cd short-ly-url-shortener
  1. Install dependencies
npm install
# or
yarn install
  1. Start the development server
npm start
# or
yarn start
  1. Open your browser and navigate to http://localhost:3000

πŸ“– Usage

Creating a Short URL

  1. Navigate to the "Shorten" tab
  2. Enter an optional title for easy identification
  3. Paste your long URL
  4. (Optional) Enter a custom alias instead of a random code
  5. Click "Shorten" to create your short URL

Managing URLs

  • Copy: Click the copy icon next to any short URL
  • QR Code: Click the QR code icon to generate a scannable code
  • Edit Title: Click the pencil icon to rename a URL
  • Delete: Click the trash icon to remove a URL
  • Simulate Click: Test the analytics by clicking "Simulate Click"

Viewing Analytics

Switch to the "Analytics" tab to see:

  • Overview statistics in cards at the top
  • Top performing URLs ranked by clicks
  • Recent activity showing latest interactions

Search and Filter

Use the search bar to find URLs by:

  • Title
  • Short URL
  • Original long URL

Use the date filter dropdown to show:

  • All time
  • Today
  • This week
  • This month

Exporting Data

Click the "Export" button to download all your URLs as a JSON file for backup or analysis.

πŸ› οΈ Built With

  • React - Frontend framework
  • Lucide React - Icon library
  • Tailwind CSS - Utility-first CSS framework
  • Web Storage API - For persistent data storage
  • QR Server API - For QR code generation

πŸ“ Project Structure

short-ly-url-shortener/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ components/
β”‚   β”‚   └── URLShortener.jsx    # Main application component
β”‚   β”œβ”€β”€ App.js
β”‚   └── index.js
β”œβ”€β”€ public/
β”œβ”€β”€ package.json
└── README.md

🎨 Design

Short.ly features a modern, minimalist design with:

  • Black background (#000000) for reduced eye strain
  • Grey highlights for subtle contrast
  • Smooth transitions for better user experience
  • Responsive layout that works on all devices
  • Intuitive interface for easy navigation

πŸ’Ύ Data Storage

All data is stored locally using the Web Storage API. This means:

  • βœ… No server required
  • βœ… Fast access to your data
  • βœ… Privacy-focused (data stays on your device)
  • ⚠️ Data is tied to your browser (use export for backup)

πŸ” Privacy

Short.ly respects your privacy:

  • All data is stored locally on your device
  • No tracking or analytics sent to external servers
  • No user accounts or authentication required
  • Export your data anytime

🀝 Contributing

Contributions are welcome! Here's how you can help:

  1. Fork the repository
  2. Create a 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

Ideas for Contributions

  • Add bulk URL import functionality
  • Implement URL expiration dates
  • Create browser extension
  • Add password protection for URLs
  • Implement URL categories/tags
  • Add more detailed analytics graphs

πŸ“ License

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

πŸ‘¨β€πŸ’» Author

Your Name - @yourhandle

Project Link: https://github.com/SYOP200/short-ly-url-shortener

πŸ™ Acknowledgments

πŸ“Έ Screenshots

Main Interface

Shorten View

Analytics Dashboard

Analytics View


⭐ Star this repository if you find it helpful!

πŸ› Known Issues

  • QR codes require internet connection to generate
  • Custom aliases are case-sensitive
  • Large exports may take a moment to process

πŸ—ΊοΈ Roadmap

  • Add URL analytics graphs
  • Implement URL categories
  • Add dark/light theme toggle
  • Create mobile app version
  • Add URL validation and preview
  • Implement URL sharing features

Made with ❀️ and React

About

A URL shortener with analytics.

Topics

Resources

License

Stars

Watchers

Forks