FREE URL Shortener 🚀

Table of Contents

• About the Project
• Getting Started
• How to Use
• Contributing
• License
• Contact

---

About the Project 📝

The URL Shortener is a simple tool that allows users to convert long URLs into short, shareable links.

• Backend: Built with Node.js.
• Frontend: Uses HTML, CSS, and JavaScript.
• Database: MongoDB (via MongoDB Atlas).

---

Getting Started 🔧

Follow these steps to set up and run the project on your computer:

1. Clone the Repository

Download the project files to your local machine:

git clone https://github.com/Pruthavirajsingh/URL-Shortner.git
cd URL-Shortner

2. Set Up the Backend

1. Navigate to the backend folder:

   cd backend

2. Install dependencies:

   npm install

3. Create a .env file inside the backend directory:

   touch .env

   Add the following lines to your .env file:

   PORT=5000
   MONGO_URI=your_mongodb_connection_string

   Replace your_mongodb_connection_string with your actual MongoDB Atlas connection string.

4. Start the backend server:

   npm start

3. Set Up the Frontend

1. Navigate to the frontend folder:

   cd ../frontend

2. Install dependencies:

   npm install

3. Start the frontend server:

   npm start

---

How to Use 🌐

1. Open the Application

• Once the servers are running, open your browser and go to:
  http://localhost:3000

2. Shorten a URL

• Enter a long URL into the input box and click the "Shorten" button.
• A shortened URL will appear on the screen.

3. Use the Shortened URL

• Click the shortened URL to instantly redirect to the original website.

---

Contributing 🤝

We welcome contributions from everyone!
Here’s how you can help:

1. Fork the project to your own GitHub account.
2. Create a new branch for your changes:

   git checkout -b feature-name

3. Make your changes and commit them:

   git commit -m "Add feature description"

4. Push to your branch:

   git push origin feature-name

5. Open a Pull Request on GitHub.

---

License 📜

This project is licensed under the MIT License. See the LICENSE file for more details.

---

Contact 📬

If you have any questions or feedback, feel free to reach out:

• Email: [email protected]
• GitHub: Pruthavirajsingh

---