Skip to content

Linkly is a JavaScript-based web application that provides a modern link management and shortening service. Easily create, organize, and share short URLs with a sleek user interface built using Tailwind CSS.

Notifications You must be signed in to change notification settings

Tailwind-Stocker/Linkly

Repository files navigation

Linkly - Your Powerful Link Shortener

Linkly is a user-friendly, feature-rich link shortener app designed to simplify and enhance your URL management experience. With Linkly, you can easily generate short, shareable links and customize them to suit your needs.


Features

  • Shorten Long URLs: Instantly create compact, shareable links for long and complex URLs.
  • Customizable URLs: Add a personal touch by customizing the alias of your shortened links.
  • Mobile-Friendly Design: Fully responsive interface, accessible on all devices.

Installation Instructions

Follow these steps to install and run Linkly:

Prerequisites

  • Node.js (v14.0.0 or higher)
  • npm package manager
  • A MongoDB instance (local or cloud-based)

Steps to Install

  1. Clone the Repository:

    git clone https://github.com/username/linkly.git
    cd linkly
  2. Install Dependencies:

    npm install
  3. Set Up Environment Variables:

    • Create a .env file in the root directory and add the following:
      MONGO_URI=<your-mongodb-connection-string>
      NEXT_PUBLIC_HOST=https:localhost:3000
      
  4. Run the Application:

    • Development Mode:
      npm run dev
    • Production Mode:
      npm run start
  5. Access the App:

    • Open your browser and navigate to http://localhost:3000.

Usage

Shorten a URL:

  • Enter the long URL in the input field and click Shorten.
  • Copy and share your new shortened link.

Contributing

We welcome contributions from the community! To contribute:

  1. Fork the repository.
  2. Create a feature branch:
    git checkout -b feature/new-feature
  3. Commit your changes:
    git commit -m "Add new feature"
  4. Push to your branch:
    git push origin feature/new-feature
  5. Submit a pull request.

License

This project is licensed under the MIT License.


Contact

For support or inquiries, feel free to reach out:

About

Linkly is a JavaScript-based web application that provides a modern link management and shortening service. Easily create, organize, and share short URLs with a sleek user interface built using Tailwind CSS.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published