{"id":14987622,"url":"https://github.com/deepraj02/ping-it","last_synced_at":"2025-04-23T03:28:13.231Z","repository":{"id":247643064,"uuid":"823230631","full_name":"deepraj02/ping-it","owner":"deepraj02","description":"A URL Shortener CLI service written in GO","archived":false,"fork":false,"pushed_at":"2025-02-26T17:42:22.000Z","size":6851,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-15T08:47:30.800Z","etag":null,"topics":["db","docker","docker-compose","gin","golang","redis","url-shortener"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/deepraj02.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":"2024-07-02T16:21:09.000Z","updated_at":"2025-02-26T17:42:25.000Z","dependencies_parsed_at":"2024-07-09T22:32:52.165Z","dependency_job_id":"a44e2b8a-955e-49c5-aa2e-97211fcd16ca","html_url":"https://github.com/deepraj02/ping-it","commit_stats":{"total_commits":20,"total_committers":1,"mean_commits":20.0,"dds":0.0,"last_synced_commit":"13f037be32074e505c64fe14ff15cd011671c6ed"},"previous_names":["deepraj02/ping-it"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepraj02%2Fping-it","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepraj02%2Fping-it/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepraj02%2Fping-it/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepraj02%2Fping-it/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deepraj02","download_url":"https://codeload.github.com/deepraj02/ping-it/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250363722,"owners_count":21418331,"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":["db","docker","docker-compose","gin","golang","redis","url-shortener"],"created_at":"2024-09-24T14:15:02.511Z","updated_at":"2025-04-23T03:28:13.216Z","avatar_url":"https://github.com/deepraj02.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PingIt: A URL Shortener CLI Service\n\nPingIt is a URL shortener service that provides both a command-line interface (CLI) and a web API, written in Go. This project is designed to offer a simple and efficient way to shorten URLs directly from your terminal or through HTTP requests.\n\n## Features\n\n- **CLI for URL Shortening**: Easily shorten URLs from the command line.\n- **Web API**: Integrate URL shortening into your applications with our HTTP API.\n- **Docker Support**: Run PingIt in a containerized environment with Docker support.\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes.\n\n### Prerequisites\n\n- Go\n- Docker\n- Task\n\n### Installing\n\nClone the repository to your local machine:\n\n```sh\ngit clone https://github.com/deepraj02/pingit.git\ncd pingit\n```\n\n## Local Development Setup\n\n### Running the Containers\n\nTo start the API containers, you can use the Task command. This will build and run the API service along with its dependencies, such as the database service, in Docker containers.\n\n```sh\ntask api-run\n```\n\nThis command is defined in the [Taskfile.yml](Taskfile.yml) and will execute the necessary Docker commands to get your API service up and running.\n\n### Building and Running the CLI\n\n#### Building the CLI\n\nTo build the CLI application, you can use the following Task command:\n\n```sh\ntask build-cli\n```\n\nThis command compiles the CLI application and places the executable in the [`cli/bin`](command:_github.copilot.openRelativePath?%5B%7B%22scheme%22%3A%22file%22%2C%22authority%22%3A%22%22%2C%22path%22%3A%22%2FUsers%2Fdeepraj%2FDeveloper%2FGo%2Fping-it%2Fcli%2Fbin%22%2C%22query%22%3A%22%22%2C%22fragment%22%3A%22%22%7D%5D \"/Users/deepraj/Developer/Go/ping-it/cli/bin\") directory. The build process is defined in the [`Taskfile.yml`](command:_github.copilot.openRelativePath?%5B%7B%22scheme%22%3A%22file%22%2C%22authority%22%3A%22%22%2C%22path%22%3A%22%2FUsers%2Fdeepraj%2FDeveloper%2FGo%2Fping-it%2FTaskfile.yml%22%2C%22query%22%3A%22%22%2C%22fragment%22%3A%22%22%7D%5D \"/Users/deepraj/Developer/Go/ping-it/Taskfile.yml\") file.\n\n#### Running the CLI\n\nAfter building the CLI, you can run it using the following Task command:\n\n```sh\ntask run-cli\n```\n\nThis command executes the CLI application, allowing you to interact with the PingIt service from your command line. The specifics of this command are also detailed in the [Taskfile.yml](Taskfile.yml) file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeepraj02%2Fping-it","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeepraj02%2Fping-it","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeepraj02%2Fping-it/lists"}