tfeuerbach / url-shortener

URL Shortener application

URL Shortener API

Python based url shortening service.
Explore the API here»

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Download and Use
3. Roadmap
4. Acknowledgments

About The Project

URL Shortenening service built for a CLI tool.

(back to top)

Getting Started

Visit http://myshortened.link to view and test the API.

Command Line tool available at url_shortener/cli.

Download and Use

1. Clone the repo

   git clone https://github.com/tfeuerbach/url_shortener.git

2. Install packages (requirements.txt)

   pip install -r requirements.txt

3. Use CLI tool to interact with the API

   cd cli/
   python clapi.py

To host your own, edit the config to point to 127.0.0.1:8000 and run:

uvicorn app.main:app --reload   

(back to top)

Roadmap

• Flexible URL Validation
• User-Friendly UI

(back to top)

Contact

Thomas Feuerbach - My LinkedIn

Project Link: https://github.com/tfeuerbach/url_shortener

(back to top)

Acknowledgments

Resources used for the creation of this application.

• Real Python
• FastAPI
• Gunicorn
• AWS

(back to top)