Skip to content

README.en.md

Latest commit

 

History

History
19 lines (15 loc) · 894 Bytes

README.en.md

File metadata and controls

19 lines (15 loc) · 894 Bytes

About

Project for learning how to create a API using FastAPI, implementing a shorening url generator. Base62 used for generating shortening url.

Description: https://roadmap.sh/projects/url-shortening-service
Deployed for testing: https://url-shortening-python-1-0-0.onrender.com/docs

Docker Hub: https://hub.docker.com/layers/fiwon123/url-shortening-python/1.0.0

Requisite

  • Python
  • SQLite
  • UV ( package manager )

How to use

  • clone either using git clone https://github.com/fiwon123/url-shortening-python.git or download it
  • Use uv sync to resolve dependencies
  • Use command standing on root folder to run API uv run uvicorn src.main:app --reload
  • Access http://127.0.0.1:8000/docs on any browser to see all endpoints and testing
  • In case to test using an external API app is necessary to use Bruno, Postman or run by command line curl for example