{"id":16505088,"url":"https://github.com/aahnik/fastapi-url-shortener","last_synced_at":"2025-10-28T00:32:26.349Z","repository":{"id":49542757,"uuid":"341804132","full_name":"aahnik/fastapi-url-shortener","owner":"aahnik","description":"Simple yet powerful URL shortener built with FastAPI. Work is in Progress. No external issues or PRs will be accepted.","archived":false,"fork":false,"pushed_at":"2023-01-29T06:54:03.000Z","size":30,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-01T10:01:37.671Z","etag":null,"topics":["analytics","async","fastapi","python","python3","url-shortener","web"],"latest_commit_sha":null,"homepage":"https://fastapi-url-shortener.herokuapp.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aahnik.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-02-24T06:37:55.000Z","updated_at":"2024-03-20T04:55:41.000Z","dependencies_parsed_at":"2023-02-15T21:15:44.187Z","dependency_job_id":null,"html_url":"https://github.com/aahnik/fastapi-url-shortener","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aahnik%2Ffastapi-url-shortener","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aahnik%2Ffastapi-url-shortener/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aahnik%2Ffastapi-url-shortener/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aahnik%2Ffastapi-url-shortener/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aahnik","download_url":"https://codeload.github.com/aahnik/fastapi-url-shortener/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238578821,"owners_count":19495450,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["analytics","async","fastapi","python","python3","url-shortener","web"],"created_at":"2024-10-11T15:09:17.222Z","updated_at":"2025-10-28T00:32:21.028Z","avatar_url":"https://github.com/aahnik.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# fastapi-url-shortener\n\nSimple yet powerful URL shortener built with [FastAPI](https://github.com/tiangolo/fastapi).\n\n**Work is in Progress. No external issues or PRs will be accepted.**\n\n- [fastapi-url-shortener](#fastapi-url-shortener)\n  - [Features](#features)\n  - [Docs](#docs)\n  - [How to deploy](#how-to-deploy)\n    - [Deploy to Heroku](#deploy-to-heroku)\n    - [Run on Localhost](#run-on-localhost)\n\n## Features\n\n- Fast and scalable\n- Shorten a long URL using a custom slug\n- Self host easily\n- Connect to your own domain\n- Integrate with other services using RESTful API\n- Free and Open Source\n\n\n## Docs\n\n- [Swagger](https://fastapi-url-shortener.herokuapp.com/docs)\n- [Redoc](https://fastapi-url-shortener.herokuapp.com/redoc)\n\n## How to deploy\n\nYou are expected to have `git` installed in your system.\n\nFirst of all clone the repository and move into the directory.\n\n  ```shell\n  git clone https://github.com/aahnik/fastapi-url-shortener\n  cd fastapi-url-shortener\n  ```\n\n### Deploy to Heroku\n\nMake sure you have [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) installed.\n\n- Create a new Heroku app\n  ```shell\n  heroku create\n  ```\n\n- Push the code to Heroku\n  ```shell\n  git push heroku main\n  ```\n\n\n\n\n### Run on Localhost\n- Install dependancies from [`requirements.txt`](requirements.txt)\n  ```shell\n  pip install -r requirements.txt\n  ```\n- Run the server using [`uvicorn`](https://github.com/encode/uvicorn)\n  ```shell\n  uvicorn main:app --reload\n  ```\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faahnik%2Ffastapi-url-shortener","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faahnik%2Ffastapi-url-shortener","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faahnik%2Ffastapi-url-shortener/lists"}