https://github.com/karthikudyawar/url-shorten

URL shortener using python
https://github.com/karthikudyawar/url-shorten

Last synced: 2 months ago
JSON representation

URL shortener using python

• Host: GitHub
• URL: https://github.com/karthikudyawar/url-shorten
• Owner: KarthikUdyawar
• Created: 2021-05-10T09:01:56.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-19T01:12:29.000Z (over 1 year ago)
• Last Synced: 2025-01-29T14:45:53.652Z (8 months ago)
• Language: Python
• Size: 37.1 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# URL-Shorten

[![Python Version](https://img.shields.io/badge/Python-3.8+-blue.svg?style=flat&logo=python&logoColor=white)](https://www.python.org/)

[![Powered by Poetry](https://img.shields.io/badge/Powered%20by-Poetry-060b55.svg?style=flat&logo=python&logoColor=white)](https://python-poetry.org/)

[![Last Commit](https://img.shields.io/github/last-commit/KarthikUdyawar/URL-Shorten?style=flat)](https://github.com/KarthikUdyawar/URL-Shorten/commits/main)

[![Repo Size](https://img.shields.io/github/repo-size/KarthikUdyawar/URL-Shorten?style=flat)](https://github.com/KarthikUdyawar/URL-Shorten)

[![Open Issues](https://img.shields.io/github/issues/KarthikUdyawar/URL-Shorten?style=flat)](https://github.com/KarthikUdyawar/URL-Shorten/issues)

[![Pull Requests](https://img.shields.io/github/issues-pr/KarthikUdyawar/URL-Shorten?style=flat)](https://github.com/KarthikUdyawar/URL-Shorten/pulls)

[![License](https://img.shields.io/github/license/KarthikUdyawar/URL-Shorten?style=flat)](https://github.com/KarthikUdyawar/URL-Shorten/blob/main/LICENSE)






  

    

  

  
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](#url-shorten)

  - [📋 Table of Contents](#-table-of-contents)

  - [🛠 About The Project](#-about-the-project)

  - [🚀 Built With](#-built-with)

  - [🏁 Getting Started](#-getting-started)

    - [Prerequisites](#prerequisites)

    - [Installation](#installation)

  - [📚 Usage](#-usage)

  - [🤝 Contributing](#-contributing)

  - [🪪 License](#-license)

  - [📬 Contact](#-contact)

  - [🙏 Acknowledgements](#-acknowledgements)

---

## 🛠 About The Project

![Screenshot](https://github.com/KarthikUdyawar/URL-Shorten/blob/main/images/Screenshot.png)

**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+](https://www.python.org/)

- [Poetry](https://python-poetry.org/)

---

## 🏁 Getting Started

### Prerequisites

- Python 3.8 or newer

- Poetry

### Installation

1. Clone the repository:

   ```bash

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

   cd URL-Shorten

   ```

2. Install dependencies:

   ```bash

   poetry install

   poetry env use python3

   ```

---

## 📚 Usage

Run the application:

```bash

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](LICENSE).

---

## 📬 Contact

Karthik Udyawar – [LinkedIn](https://www.linkedin.com/in/karthik-udyawar-0489991b3) – karthikajitudy@gmail.com

Project Link: [https://github.com/KarthikUdyawar/URL-Shorten](https://github.com/KarthikUdyawar/URL-Shorten)

---

## 🙏 Acknowledgements

- [Poetry](https://python-poetry.org/)

- [Shield.io Badges](https://shields.io)

- [Markdown Guide](https://www.markdownguide.org/)

---