Skip to content

README.md

Latest commit

 

History

History
74 lines (46 loc) · 1.65 KB

README.md

File metadata and controls

74 lines (46 loc) · 1.65 KB
Raw

URL Shortener

A simple URL shortening web application built with Node.js, Express, and MongoDB.

ScreenShot

Mobile View

Desktop View

Features

  • Shorten long URLs to concise and shareable short links.
  • Copy short URLs to the clipboard with a click.

Getting Started

Prerequisites

  • Node.js installed
  • MongoDB installed and running

Installation

  1. Clone the repository:

    git clone https://github.com/FreeCode911/Minolink.git

  2. Navigate to the project directory:

    cd url-shortener

  3. Install dependencies:

    npm install

  4. Open file named config.json in the project root:

    {
 "mongodb_url": "mongodb+srv://admin:admin@lykcloud.me/url-shortener", //Remove In MongoDB ( ?retryWrites=true&w=majority ) EG:- mongodb+srv://USERNAME:PASSWORD@xx/ANY_NAME
 "port": 3000,
 "website_url": "https://example.com", //Website Url Must Be https://example.com Do Not Add https://example.com/ , https://example.com//, etc..
}

Usage

  1. Start the application:

    npm start

  2. Open your browser and visit https://your-domain.com.

  3. Enter a long URL in the input box and click "Shorten URL."

  4. Copy the generated short URL and share it!

Configuration

You can customize the website URL by modifying the config.json file.