/Shorty-App

Primary LanguagePHP

Shorty-App 🚀

Shorty-App is a URL shortening service designed to make your links concise and shareable. What sets it apart is its advanced analytics, providing detailed insights into user interactions.

Features

  • URL Shortening: Quickly create short and memorable URLs.
  • Title Integration: Organize links with customizable titles.
  • Analytics Dashboard: Gain insights into user interactions:
    • User Agent: Identify device, OS, and browser.
    • IP Address: Track user's IP address.
    • Regional Location: Discover user's regional location.
    • Username: Retrieve user-associated information.
    • Created Time: Know when the short URL was created.
    • Long URL: View the original, long URL.
    • Short URL: Access the unique short URL.
    • Analytics Data URL: Explore detailed analytics in a new tab.

Getting Started

Installation

  1. Clone the repository: git clone https://github.com/your-username/shorty-app.git
  2. Navigate to the project directory: cd shorty-app
  3. Install dependencies: npm install
  4. Start the application: npm start

Usage

  1. Create a short URL:

    • Provide a title and the long URL.
    • npm run shorten --title "Your Title" --url "https://your-long-url.com"

  2. View Analytics:

    • Access the analytics dashboard to see detailed user interaction data.

  3. Explore Analytics Data:

    • Open the analytics data URL in a new tab to delve deeper into user-specific details.

Prerequisites

Before using Shorty-App, ensure you have Node.js and npm installed.

# Example for Debian-based systems
sudo apt-get update
sudo apt-get install nodejs
sudo apt-get install npm

Contributing
We welcome contributions! Please read our contribution guidelines before submitting pull requests.

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

## Acknowledgments 🙌

I would like to extend my sincere gratitude to:

- **Gulzar Ahmad:** My mentor and guide throughout the development of Shorty-App. Your support, insights, and encouragement have been invaluable. This project wouldn't have been possible without your expertise and guidance.

- **The open-source community:** For inspiration, collaboration, and the wealth of knowledge shared.

- **[Contributor Names]:** For their invaluable contributions to Shorty-App.

- **[Any other acknowledgments or credits]**

Your support and contributions make Shorty-App better for everyone. Thank you!