Skip to content

sam28u/UrlShortener

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 

Repository files navigation

URL Shortener Web Application

Description

URL Shortener Web Application is a user-friendly web-based tool that allows users to create shortened versions of long URLs, making them easier to share. This project is built using the MERN stack (MongoDB, Express, React, Node.js) and styled with Chakra UI for a visually appealing and responsive user interface.

Features

  • Shorten URLs: Convert long URLs into shortened versions with a single click.
  • Custom Short URLs (Optional): Create personalized and memorable links for your URLs.
  • Copy to Clipboard: Copy the shortened URL to the clipboard for easy sharing.
  • User-friendly Interface: Intuitive and responsive UI design for a seamless user experience.

Installation

To run the URL Shortener Web Application locally, follow these steps:

  1. Clone the repository:

  2. Install dependencies for both frontend and backend:

cd server npm install cd client npm install

  1. Set up environment variables:
  • Create a .env file in the root directory and add the following:
    MONGODB_URI=your-mongodb-uri
    PORT=your-port-number
    
  1. Start the development server:

-Server npm start -Client npm run start

The URL Shortener Web Application will be running on http://localhost:your-port-number.

Usage

  1. Access the application at http://localhost:your-port-number in your web browser.
  2. Enter the long URL you want to shorten in the input field.
  3. Optionally, you can provide a custom short URL code for the link.
  4. Click the "Shorten URL" button to generate the shortened version.
  5. The shortened URL will be displayed in the output field, and it will be automatically copied to your clipboard for easy sharing.

Technologies Used

  • Frontend:

  • React

  • Chakra UI

  • React Router

  • Axios

  • Backend:

  • Node.js

  • Express

  • MongoDB (via Mongoose)

Contributing

Contributions are welcome! If you find any bugs or have suggestions for improvements, please create a new issue or submit a pull request.

About

UrlShortener

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published