{"id":21474442,"url":"https://github.com/tab/shortly","last_synced_at":"2025-03-17T07:41:51.356Z","repository":{"id":258346729,"uuid":"863679949","full_name":"tab/shortly","owner":"tab","description":"URL shortener service","archived":false,"fork":false,"pushed_at":"2024-10-22T19:16:20.000Z","size":154,"stargazers_count":0,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-24T08:57:54.848Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":false,"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/tab.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,"publiccode":null,"codemeta":null}},"created_at":"2024-09-26T18:04:18.000Z","updated_at":"2024-10-20T11:52:31.000Z","dependencies_parsed_at":"2024-10-22T19:29:27.519Z","dependency_job_id":null,"html_url":"https://github.com/tab/shortly","commit_stats":null,"previous_names":["tab/shortly"],"tags_count":0,"template":false,"template_full_name":"Yandex-Practicum/go-musthave-shortener-tpl","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tab%2Fshortly","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tab%2Fshortly/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tab%2Fshortly/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tab%2Fshortly/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tab","download_url":"https://codeload.github.com/tab/shortly/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243996323,"owners_count":20380977,"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":[],"created_at":"2024-11-23T10:22:56.773Z","updated_at":"2025-03-17T07:41:51.351Z","avatar_url":"https://github.com/tab.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Shortly\n\n## Overview\nShortly is a Go application designed to shorten long URLs\n\n## Setup Instructions\n\n### Prerequisites\n\n**Docker** and **Docker Compose** installed on your machine\n\n### Build\n\n```sh\ndocker-compose build\n```\n\n### Database setup\n\n```sh\ndocker-compose up -d database\n```\n\n```sh\nGO_ENV=development make db:create db:migrate\n```\n\n#### Database management commands\n\nThe Makefile provides commands for managing the database:\n\n    Create Database: make db:create\n    Drop Database: make db:drop\n    Apply Migrations: make db:migrate\n    Check Migration Status: make db:migrate:status\n    Rollback Last Migration: make db:rollback\n    Dump Schema: make db:schema:dump\n    Load Schema: make db:schema:load\n\n### Run application\n\n```sh\ndocker-compose up backend\n```\n\n### API Documentation\n\nCheck api/swagger.yml for the API documentation\n\n### Development\n\nCheck `.env.development` for the environment variables\nand `.env.test` for the test environment variables\n\n#### Prepare test environment\n\n```sh\nGO_ENV=test make db:create db:schema:load\n```\n\nUnit Tests:\n\n```sh\nGO_ENV=test make test\n```\n\nTest Coverage:\n\n```sh\nmake coverage\n```\n\nCode Vetting:\n\n```sh\nmake vet\n```\n\nLinting:\n\n```sh\nmake lint\n```\n\n### Profiling\n\nGenerate payload with wrk tool:\n\n```sh\nmake benchmark:payload\n```\n\nCreate CPU and Memory profiles:\n\n```sh\nmake pprof:cpu\nmake pprof:mem\n```\n\nCompare profiles:\n\n```sh\nmake pprof:cpu:diff\nmake pprof:mem:diff\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftab%2Fshortly","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftab%2Fshortly","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftab%2Fshortly/lists"}