{"id":20268815,"url":"https://github.com/dammak/punnify","last_synced_at":"2025-07-11T23:35:53.723Z","repository":{"id":117434823,"uuid":"407920124","full_name":"DAMMAK/punnify","owner":"DAMMAK","description":null,"archived":false,"fork":false,"pushed_at":"2021-09-19T18:43:49.000Z","size":58,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-14T05:27:18.239Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/DAMMAK.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":"2021-09-18T17:07:10.000Z","updated_at":"2021-09-28T08:43:06.000Z","dependencies_parsed_at":"2023-03-09T22:30:27.719Z","dependency_job_id":null,"html_url":"https://github.com/DAMMAK/punnify","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/DAMMAK%2Fpunnify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DAMMAK%2Fpunnify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DAMMAK%2Fpunnify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DAMMAK%2Fpunnify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DAMMAK","download_url":"https://codeload.github.com/DAMMAK/punnify/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241753144,"owners_count":20014252,"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-14T12:20:17.162Z","updated_at":"2025-03-03T23:05:03.709Z","avatar_url":"https://github.com/DAMMAK.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Punnify\n\nURL shortener service\n\n## How to run\n\n```bash\nnpm install\n\n#to run in dev mode\nnpm run  dev\n\n# to run in prod mode\nnpm start\n```\n\n## Usage\n\nit has 3 available endpoints routes. `/getUrls`, `/getUrl` , `/`\n\n### /getUrls\n\nthis endpoint return all the available url data from the database\n\nHttp Method: `GET`\n\nexample response\n\n```Javascript\n{\n\"data\": [\n{\n\"_id\": \"61476c8d2ade7ff56b35b593\",\n\"fullUrl\": \"http://google.com\",\n\"shortUrl\": \"HwFEnrCV\",\n\"visited\": 3,\n\"__v\": 0\n},\n{\n\"_id\": \"61476e512ade7ff56b35b5af\",\n\"fullUrl\": \"http://quickteller-merchant-ui.k8.isw.la/\",\n\"shortUrl\": \"oqy29Kye\",\n\"visited\": 2,\n\"__v\": 0\n},\n{\n\"_id\": \"61476cb32ade7ff56b35b597\",\n\"fullUrl\": \"http://stackoverflow.com\",\n\"shortUrl\": \"wl-k3wJk\",\n\"visited\": 1,\n\"__v\": 0\n},\n{\n\"_id\": \"61476dda2ade7ff56b35b5a6\",\n\"fullUrl\": \"http://calendar.google.com\",\n\"shortUrl\": \"1OS1Lx1B\",\n\"visited\": 1,\n\"__v\": 0\n},\n{\n\"_id\": \"614777dff4423560b6936fcd\",\n\"fullUrl\": \"http://docs.google.com/document/d/1VEhuVK2K3v6IoSa8LPair6Bqo6BxWt7h7nCze34vPOg/edit\",\n\"shortUrl\": \"cD3Sr8H9\",\n\"visited\": 0,\n\"__v\": 0\n}\n]\n}\n```\n\n### /getUrl\n\nthis endpoint returns URL data of using the `shortUrl` as the param criteria\n\nexample request: `http://localhost:5000/HwFEnrCV`\n\nexample response\n\n```Javascript\n{\n\"fullUrl\": \"http://google.com\",\n\"shortUrl\": \"HwFEnrCV\"\n}\n```\n\n### /getUrl [POST]\n\nthis endpoint allows user to shorten URL\n\nHttp Method: `POST`\n\nexample request:\n\n```Javascript\n\n{\n    \"url\": \"google.com\"\n}\n```\n\nexample response\n\n```Javascript\n{\n\"fullUrl\": \"http://google.com\",\n\"shortUrl\": \"HwFEnrCV\"\n}\n```\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdammak%2Fpunnify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdammak%2Fpunnify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdammak%2Fpunnify/lists"}