https://github.com/rggh/smurl

smaller url
https://github.com/rggh/smurl

fastapi python url-shortener

Last synced: about 1 month ago
JSON representation

smaller url

• Host: GitHub
• URL: https://github.com/rggh/smurl
• Owner: RGGH
• Created: 2022-08-01T09:37:33.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-08-01T10:07:29.000Z (almost 4 years ago)
• Last Synced: 2025-07-17T05:37:01.434Z (12 months ago)
• Topics: fastapi, python, url-shortener
• Language: Python
• Homepage:
• Size: 5.86 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Fast API url shortener - a bit like bitly

[![Python application](https://github.com/RGGH/smurl/actions/workflows/python-app.yml/badge.svg)](https://github.com/RGGH/smurl/actions/workflows/python-app.yml)

![im](https://github.com/RGGH/url_shortener/blob/main/docs/2022-07-29%2016-57-30.gif)

API contains the following components; 

- An endpoint that accepts a URL to be shortened and returns a short url : `/api-1.0/create-short`

- An endpoint that accepts a short URL and returns or redirects to the original URL : `/api-1.0/visit-short`

Usage;

- A CLI that can be used to call the service : `python user_cli.py`

---

#### Install requirements `pip install -r requirements.txt`

#### Start server `bash server.sh`

#### Call service : `python user_cli.py`  


Developed for Linux/Mac - run in WSL on Windows