{"id":15044058,"url":"https://github.com/codfish/generator-vercel-shortener","last_synced_at":"2025-10-23T20:32:20.761Z","repository":{"id":57249204,"uuid":"259064195","full_name":"codfish/generator-vercel-shortener","owner":"codfish","description":"Generate your own personal url shortener to deploy to Vercel.","archived":false,"fork":false,"pushed_at":"2022-08-10T18:39:14.000Z","size":21,"stargazers_count":15,"open_issues_count":0,"forks_count":10,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-09-27T10:40:13.159Z","etag":null,"topics":["url-shortener","yeoman-generator"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/codfish.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}},"created_at":"2020-04-26T15:25:09.000Z","updated_at":"2024-07-07T14:11:30.000Z","dependencies_parsed_at":"2022-08-24T16:30:40.818Z","dependency_job_id":null,"html_url":"https://github.com/codfish/generator-vercel-shortener","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codfish%2Fgenerator-vercel-shortener","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codfish%2Fgenerator-vercel-shortener/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codfish%2Fgenerator-vercel-shortener/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codfish%2Fgenerator-vercel-shortener/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codfish","download_url":"https://codeload.github.com/codfish/generator-vercel-shortener/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219867845,"owners_count":16555812,"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":["url-shortener","yeoman-generator"],"created_at":"2024-09-24T20:50:00.818Z","updated_at":"2025-10-23T20:32:15.135Z","avatar_url":"https://github.com/codfish.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# generator-vercel-shortener\n\n\u003e Generator to create your own personal url shortener to deploy to Vercel (formerly Zeit Now).\n\n[![version][version-badge]][package] [![downloads][downloads-badge]][npmcharts]\n[![GitHub Workflow Status][actions-badge]][actions-badge] [![MIT License][license-badge]][license]\n[![PRs Welcome][prs-badge]][prs] [![Semantic Release][semantic-release-badge]][semantic-release]\n[![Commitizen friendly][commitizen-badge]][commitizen]\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n\n- [Getting Started](#getting-started)\n- [Installation](#installation)\n- [Usage](#usage)\n- [After you generate](#after-you-generate)\n- [Related Projects](#related-projects)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n## Getting Started\n\nThese aren't prerequisites but before you're able to actually deploy your url shortener you should:\n\n1. Create a [Vercel account](https://vercel.com/signup).\n1. Set up Vercel\n   [GitHub Integration](https://vercel.com/docs/concepts/git/vercel-for-github). This way\n   Vercel deploys automatically for you.\n1. Buy, migrate or simply point a domain you already own to Vercel's dns.\n\nYou don't technically need to have a domain. By default your new project in Vercel will be deployed\nwith a domain like `https://my-url-shortener.vercel.app`, and your redirects will work just fine.\nHowever part of the glory of url shorteners is that they create **short urls** that are easy to type\nand remember!\n\n## Installation\n\n```sh\nnpm install -g yo generator-vercel-shortener\n```\n\n## Usage\n\n```sh\nyo vercel-shortener\n```\n\nBy default it will look to generate in your current working directory. If that's not what you want,\nthen specify the directory in the call or create a new directory to run the generator in.\n\n```sh\nyo vercel-shortener [\u003cproject-directory\u003e]\n```\n\n_or..._\n\n```sh\nmkdir \u003cproject-directory\u003e\ncd \u003cproject-directory\u003e\nyo vercel-shortener\n```\n\n## After you generate\n\nNext steps after generating:\n\n1. Create a repository for your url shortener, [https://github.com/new](https://github.com/new).\n1. Run `git remote add origin \u003crepo_url\u003e`.\n1. Run `git push origin main`.\n1. Run `git branch -u origin/main`.\n1. Run `vercel` to setup \u0026 deploy your project to Vercel.\n1. Add redirects:\n   - Run `shorten \u003cdestination\u003e [\u003csource\u003e]`. The generator will expose a globally available script\n     for you. Run this from anywhere in your terminal. See\n     [vercel-redirects](https://github.com/codfish/vercel-redirects) for the full cli documentation.\n   - Run `npm run shorten \u003cdestination\u003e [\u003csource\u003e]` from the root of the project.\n   - Add them in `vercel.json` [manually](https://vercel.com/docs/configuration#project/redirects).\n     You'll need to commit and push them yourself.\n\nFor example:\n\n```sh\nshorten https://gist.github.com/codfish/91ef26f3a56a5c5ca0912aa8c0c5c020 /linting\n```\n\nAnd in about ~5 seconds I can hit [codfi.sh/linting](https://codfi.sh/linting) and it will redirect\nfor me.\n\n## Related Projects\n\n- [`codfi.sh`](https://github.com/codfish/codfi.sh) - My own personal url shortener, using the same\n  configuration as a project built with this generator.\n- [`vercel-redirects`](https://github.com/codfish/vercel-redirects) - Command-line utility to manage\n  your Vercel project redirects.\n- [`netlify-shortener`](https://github.com/kentcdodds/netlify-shortener) - Your own free URL\n  shortener with Netlify (different serverless platform).\n\n[npm]: https://www.npmjs.com/\n[node]: https://nodejs.org\n[semantic-release]: https://github.com/semantic-release/semantic-release\n[semantic-release-badge]:\n  https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square\n[prs]: http://makeapullrequest.com\n[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square\n[commitizen]: http://commitizen.github.io/cz-cli/\n[commitizen-badge]:\n  https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square\n[npmcharts]: http://npmcharts.com/compare/generator-vercel-shortener\n[version-badge]: https://img.shields.io/npm/v/generator-vercel-shortener.svg?style=flat-square\n[package]: https://www.npmjs.com/package/generator-vercel-shortener\n[downloads-badge]: https://img.shields.io/npm/dm/generator-vercel-shortener.svg?style=flat-square\n[license-badge]: https://img.shields.io/npm/l/generator-vercel-shortener.svg?style=flat-square\n[license]: https://github.com/codfish/generator-vercel-shortener/blob/main/LICENSE\n[actions]: https://github.com/codfish/generator-vercel-shortener/actions\n[actions-badge]:\n  https://img.shields.io/github/workflow/status/codfish/generator-vercel-shortener/Release/main?style=flat-square\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodfish%2Fgenerator-vercel-shortener","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodfish%2Fgenerator-vercel-shortener","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodfish%2Fgenerator-vercel-shortener/lists"}