{"id":20443551,"url":"https://github.com/torhamdev/link-shortener-fastapi","last_synced_at":"2025-04-12T23:50:34.320Z","repository":{"id":65405620,"uuid":"591308631","full_name":"TorhamDev/link-Shortener-FastAPI","owner":"TorhamDev","description":"a simple link shortener with FastAPI","archived":false,"fork":false,"pushed_at":"2023-03-02T18:57:07.000Z","size":10925,"stargazers_count":12,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-26T17:56:26.864Z","etag":null,"topics":["docker","docker-compose","fastapi","mysql","python","redis"],"latest_commit_sha":null,"homepage":"","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/TorhamDev.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-20T12:50:37.000Z","updated_at":"2024-02-28T19:56:07.000Z","dependencies_parsed_at":"2024-11-15T09:58:11.742Z","dependency_job_id":null,"html_url":"https://github.com/TorhamDev/link-Shortener-FastAPI","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TorhamDev%2Flink-Shortener-FastAPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TorhamDev%2Flink-Shortener-FastAPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TorhamDev%2Flink-Shortener-FastAPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TorhamDev%2Flink-Shortener-FastAPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TorhamDev","download_url":"https://codeload.github.com/TorhamDev/link-Shortener-FastAPI/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248647252,"owners_count":21139081,"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":["docker","docker-compose","fastapi","mysql","python","redis"],"created_at":"2024-11-15T09:48:07.700Z","updated_at":"2025-04-12T23:50:34.293Z","avatar_url":"https://github.com/TorhamDev.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Link shortener with FastAPI\n\u003e a simple link shortener with FastAPI\n\nMy practice for using FastAPI.\nIn this exercise, a link shortening system is built and it is tried to be optimized as much as possible.\n\nTechnologies such as Docker and Redis are also used in this exercise.\n\n## Technologies used:\n![image](https://img.shields.io/badge/Python-FFD43B?style=for-the-badge\u0026logo=python\u0026logoColor=blue)\n![image](https://img.shields.io/badge/fastapi-109989?style=for-the-badge\u0026logo=FASTAPI\u0026logoColor=white)\n![image](https://img.shields.io/badge/redis-CC0000.svg?\u0026style=for-the-badge\u0026logo=redis\u0026logoColor=white)\n![image](https://img.shields.io/badge/Docker-2CA5E0?style=for-the-badge\u0026logo=docker\u0026logoColor=white)\n![image](https://img.shields.io/badge/MySQL-005C84?style=for-the-badge\u0026logo=mysql\u0026logoColor=white)\n\n# How to Run?\nYou can run this project in three ways. manually, using docker-compose and using Docker\n\n## Manually\n```bash\n\n# clone the project\ngit clone https://github.com/TorhamDev/link-Shortener-FastAPI.git\n\ncd link-Shortener-FastAPI\n\n# install libs\npip install -r requirements.txt\n\n# run the projct\nuvicorn main:app --host 0.0.0.0 --port 8080\n```\n\n## Using docker-compose\n```bash\n# clone the project\ngit clone https://github.com/TorhamDev/link-Shortener-FastAPI.git\n\ncd link-Shortener-FastAPI\n\n# Run and build project\ndocker-compose up --build  -d\n\n```\n\n\n## Using docker \n```bash\n# clone the project\ngit clone https://github.com/TorhamDev/link-Shortener-FastAPI.git\n\ncd link-Shortener-FastAPI\n\n# building docker image\ndocker build -t fast-api-link .\n\n# run the project on 8080 port\ndocker run -d -p 8080:8080 fast-api-link\n```\n\n# admin panel\nToo see admin panel after running, go to the `/admin/`\n\n# Document\n**To see the project document, after running it, go to the `/redoc` or `/docs` path and view the document**\n\n\n# License\n[![Licence](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftorhamdev%2Flink-shortener-fastapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftorhamdev%2Flink-shortener-fastapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftorhamdev%2Flink-shortener-fastapi/lists"}