/url_Shortener

LaghuSuchakstalam app serve as practical tools to simplify and optimize links, enabling users to efficiently share and access online content.

Primary LanguageJavaScript

URL Shortener Project

URL Shortener Logo

Table of Contents

Introduction

A Laghusuchakstalam app is a web application that takes long URLs (Uniform Resource Locators) and converts them into shorter, more manageable links. The primary purpose of a URL shortener is to create concise and shareable links that are easier to remember and share, especially on platforms with character limitations like social media.

Features

  • Shorten long URLs into compact and shareable links.
  • Customizable short URLs (if not already taken).
  • Redirect users to the original long URL when they access the shortened link.
  • Analytics tracking to monitor the usage of shortened URLs (e.g., number of clicks, geographic locations, etc.).

Technologies Used

  • Frontend: React js , Tailwind Css
  • Backend: Node.js, Express.js
  • Database: MongoDB
  • Deployment: versel,cyclic

Getting Started

To run the URL Shortener project locally, follow these steps:

  1. Clone the repository: git clone https://github.com/shubhamthite09/url-shortener.git
  2. cd into backend cd backend
  3. Install the required dependencies: npm install
  4. Set up the MongoDB database. remote url in .env file
  5. Start the server: npm start start the backend on required port
  6. Then cd frontend
  7. Then change the backend URl in .env file
  8. Open your web browser and visit http://localhost:3000

Usage

  1. On the homepage, and login
  2. enter the long URL you want to shorten.
  3. Click on the "Shorten" button to generate the short URL.
  4. The shortened URL will be displayed along with statistics (e.g., number of clicks).
  5. Users can copy the short URL and share it with others.

API Endpoints

  1. user/login
  2. user/register
  3. url/create
  4. url/get
  5. url/delete

Backend End Point:- https://giant-jay-fatigues.cyclic.app

Contributing

We welcome contributions to the URL Shortener project. If you find a bug or have an idea for improvement, please feel free to open an issue or submit a pull request.

  1. Fork the repository.
  2. Create your feature branch: git checkout -b feature/your-feature-name
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin feature/your-feature-name
  5. Open a pull request explaining your changes.

We hope you find the URL Shortener project useful! If you have any questions or need further assistance, feel free to contact me at shubhamthite09@gmail.com. Happy shortening!