Skip to content

Latest commit

 

History

History
84 lines (53 loc) · 2.6 KB

README.md

File metadata and controls

84 lines (53 loc) · 2.6 KB

URL Shortener

A fast and easy-to-use URL shortening service that lets you shorten long URLs into short, shareable links. Because who likes long URLs anyway?

Features

  • Shorten URLs: Quickly shorten any long URL to make it easier to share. Shorter is better!
  • Track URL Usage: Provides basic tracking of how many times a short URL has been clicked. Let's see who's clicking!
  • Custom Aliases: Option to customize your shortened URL's alias. Make it snappy, make it catchy.
  • User-Friendly Interface: Clean and simple UI for seamless URL shortening. Even your grandma can use it (we hope).

Installation

Prerequisites

Ensure you have the following installed on your machine:

  • Node.js (Don’t worry, it’s not as hard to install as your grandma’s Wi-Fi)
  • npm (Node Package Manager)

Steps to run locally

  1. Clone the repository:

    git clone https://github.com/your-username/url-shortener.git

  2. Navigate to the project directory:

    cd url-shortener

  3. Install the required dependencies:

    npm install

  4. Set up your database (no, it’s not like setting up IKEA furniture, I promise).

  5. Start the application:

    npm start

  6. Open your browser and go to http://localhost:3000 to see the URL shortener in action. It’s like magic, but with code.

Usage

  1. Shorten URL:

    • Enter the long URL in the input field and click "Shorten". It's like turning your long, boring link into a cool secret code.

  2. Custom Alias:

    • You can optionally enter a custom alias for your shortened URL. Make it something memorable like “ShortAndSweet”.

  3. Tracking:

    • After shortening the URL, you'll be able to see a shortened link with a click count. Feel free to brag about how popular your link is.

  4. Share:

    • Copy the generated shortened URL and share it on social media, in messages, or anywhere you want. Sharing is caring, after all.

Technologies Used

  • Frontend:

    • HTML, CSS, JavaScript
    • React (because why not make everything awesome with React?)

  • Backend:

    • Node.js (The engine that powers this ship!)
    • Express (For when you want to keep things efficient and fast)

  • Database:

    • MongoDB (The brain behind your URL-shortening magic)

Contributing

Feel free to fork the repository, submit issues, or open pull requests to contribute to the project. Just remember, no one likes a messy PR.

License

This project is licensed under the MIT License - see the LICENSE file for details. It's like the "get out of jail free" card for open-source projects.