URL-Shorten

URL-Shorten

A simple and lightweight URL shortener built with Python.
Explore the docs »

View Demo · Report Bug · Request Feature

---

📋 Table of Contents

• URL-Shorten
  • 📋 Table of Contents
  • 🛠 About The Project
  • 🚀 Built With
  • 🏁 Getting Started
    • Prerequisites
    • Installation
  • 📚 Usage
  • 🤝 Contributing
  • 🪪 License
  • 📬 Contact
  • 🙏 Acknowledgements

---

🛠 About The Project

URL-Shorten allows users to easily shorten long URLs with a clean and minimal UI. Focus is on simplicity, local usage, and zero-dependency outside Python and Poetry.

---

🚀 Built With

• Python 3.8+
• Poetry

---

🏁 Getting Started

Prerequisites

• Python 3.8 or newer
• Poetry

Installation

1. Clone the repository:

   git clone https://github.com/KarthikUdyawar/URL-Shorten
   cd URL-Shorten

2. Install dependencies:

   poetry install
   poetry env use python3

---

📚 Usage

Run the application:

poetry run python main.py

Shorten your URLs easily through the UI!

---

🤝 Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feat/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feat/AmazingFeature)
5. Open a Pull Request

---

🪪 License

Distributed under the MIT License.

---

📬 Contact

Karthik Udyawar – LinkedIn – karthikajitudy@gmail.com

Project Link: https://github.com/KarthikUdyawar/URL-Shorten

---

🙏 Acknowledgements

• Poetry
• Shield.io Badges
• Markdown Guide

---