{"id":44419163,"url":"https://github.com/aoamusat/urlshort","last_synced_at":"2026-02-12T09:09:12.565Z","repository":{"id":216876047,"uuid":"742501332","full_name":"aoamusat/urlshort","owner":"aoamusat","description":"A URL Shortening service","archived":false,"fork":false,"pushed_at":"2024-04-25T09:03:39.000Z","size":52,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-25T10:26:35.658Z","etag":null,"topics":["alembic","fastapi","javascript","postgresql","sqlalchemy","tailwindcss"],"latest_commit_sha":null,"homepage":"https://urlshorter-8m42.onrender.com/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aoamusat.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2024-01-12T16:10:19.000Z","updated_at":"2024-04-25T10:26:39.592Z","dependencies_parsed_at":"2024-04-25T10:26:38.175Z","dependency_job_id":"c18c994c-9323-4d34-bd87-8046452a5a33","html_url":"https://github.com/aoamusat/urlshort","commit_stats":null,"previous_names":["aoamusat/urlshort"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/aoamusat/urlshort","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aoamusat%2Furlshort","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aoamusat%2Furlshort/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aoamusat%2Furlshort/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aoamusat%2Furlshort/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aoamusat","download_url":"https://codeload.github.com/aoamusat/urlshort/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aoamusat%2Furlshort/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29362234,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-12T08:51:36.827Z","status":"ssl_error","status_checked_at":"2026-02-12T08:51:26.849Z","response_time":55,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["alembic","fastapi","javascript","postgresql","sqlalchemy","tailwindcss"],"created_at":"2026-02-12T09:09:12.065Z","updated_at":"2026-02-12T09:09:12.558Z","avatar_url":"https://github.com/aoamusat.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# URL Shortening Service\n\n![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/aoamusat/urlshort/create-release.yml) ![GitHub Release](https://img.shields.io/github/v/release/aoamusat/urlshort)\n\nThis is a URL shortening service implemented using FastAPI, Python, PostgreSQL, and Docker.\n\n## Table of Contents\n\n- [URL Shortening Service](#url-shortening-service)\n  - [Table of Contents](#table-of-contents)\n  - [Overview](#overview)\n  - [Features](#features)\n  - [Prerequisites](#prerequisites)\n  - [Getting Started](#getting-started)\n    - [Installation](#installation)\n    - [Configuration](#configuration)\n    - [Usage](#usage)\n    - [API Documentation](#api-documentation)\n- [Docker Support](#docker-support)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Overview\n\nThis URL shortening service allows users to shorten long URLs into concise, easy-to-share short links. It is built on the FastAPI framework, uses PostgreSQL as the database, and is containerized with Docker for easy deployment.\n\n## Features\n\n- Shorten long URLs into short links.\n- Retrieve original URLs using short links.\n- FastAPI-based RESTful API.\n- PostgreSQL database for persistent storage.\n- Docker support for containerized deployment.\n\n## Prerequisites\n\nMake sure you have the following installed on your system:\n\n- Docker\n- Docker Compose\n- Python 3.8 or higher\n\n## Getting Started\n\n### Installation\n\n- Clone the repository:\n\n   ```bash\n   git clone https://github.com/aoamusat/urlshort.git\n   cd urlshort\n   ```\n- Install the project dependencies:\n\n   ```bash\n   pip install -r requirements.txt\n   ```\n\n- Run database migrations:\n\n   ```bash\n   alembic upgrade head\n   ```\n### Configuration\n\n\n- Set environment variables:\n\n   ```bash\n    export DATABASE_URL=postgresql://user:password@host/db\n    export BASE_URL=URL # Optional\n    ```\n\n## Run the FastAPI development server\n```bash\nuvicorn main:app --reload --port 80\n```\nVisit http://localhost/docs in your browser to access the Swagger documentation.\n\n### Usage\nUse the API documentation to interact with the service.\nShorten long URLs and retrieve original URLs using the provided API endpoints.\n### API Documentation\nThe API documentation is available at http://localhost/docs.\n\n\n# Docker Support\nThe service can be containerized using Docker. Use the provided Dockerfile for deployment.\n\n```bash\n# Build the Docker image\ndocker build -t url-shortener .\n```\n\nAlternatively, you can pull the Docker image from the Docker public repository\n```bash\ndocker pull akeemamusat511/urlshorter:latest\n```\n\n# Contributing\nFeel free to contribute to the project. Fork the repository, make your changes, and submit a pull request.\n\n# License\nThis project is licensed under the MIT License.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faoamusat%2Furlshort","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faoamusat%2Furlshort","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faoamusat%2Furlshort/lists"}