Skip to content

A simple and user-friendly URL shortener with analytics and heatmap visualization. Built with Laravel and React.

Notifications You must be signed in to change notification settings

riquena969/shorty

Repository files navigation

Shorty

Shorty is a simple and user-friendly URL shortener built with Laravel and React. It allows you to create, manage, and track short links with ease. The project is designed for easy deployment and provides a modern, intuitive interface for users.

Features

  • Create short URLs with custom aliases
  • Track visits and analytics for each link
  • Heatmap visualization of clicks by country
  • Expiration and visit limits for links
  • Responsive and clean UI
  • Authentication and user management

Getting Started

Requirements

  • PHP 8.1+
  • Composer
  • Node.js 18+
  • SQLite (default) or other supported database

Installation

  1. Clone the repository:
    git clone https://github.com/your-username/shorty.git
    cd shorty
  2. Install PHP dependencies:
    composer install
  3. Install JavaScript dependencies:
    npm install
  4. Copy the example environment file and set your variables:
    cp .env.example .env
    php artisan key:generate
  5. Run migrations:
    php artisan migrate
  6. Build frontend assets:
    npm run build
  7. Start the development server:
    php artisan serve

Access the app at http://localhost:8000.

Usage

  • Register or log in to your account
  • Create new short URLs from the dashboard
  • View analytics and heatmaps for each link
  • Manage, edit, or delete your links

Issues & Suggestions

Found a bug? Have an idea for a new feature? Please open an issue on GitHub! Suggestions and contributions are very welcome. Help us make Shorty even better for everyone.

License

This project is open source and available under the MIT License.

About

A simple and user-friendly URL shortener with analytics and heatmap visualization. Built with Laravel and React.

Topics

Resources

Stars

Watchers

Forks