{"id":22864433,"url":"https://github.com/1weiho/gh-link","last_synced_at":"2025-05-05T04:03:17.980Z","repository":{"id":153760087,"uuid":"612324850","full_name":"1weiho/gh-link","owner":"1weiho","description":"A Link in Bio website configured with only a JSON file.","archived":false,"fork":false,"pushed_at":"2024-02-04T16:25:27.000Z","size":891,"stargazers_count":16,"open_issues_count":9,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-05T04:02:27.473Z","etag":null,"topics":["json-configuration","linkinbio","nextjs","vercel"],"latest_commit_sha":null,"homepage":"https://gh-link.vercel.app","language":"TypeScript","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/1weiho.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}},"created_at":"2023-03-10T17:30:22.000Z","updated_at":"2025-03-03T21:51:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"ff1dacb8-5e58-45c2-b911-283b1854dfec","html_url":"https://github.com/1weiho/gh-link","commit_stats":null,"previous_names":["1weiho/gh-link"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1weiho%2Fgh-link","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1weiho%2Fgh-link/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1weiho%2Fgh-link/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1weiho%2Fgh-link/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/1weiho","download_url":"https://codeload.github.com/1weiho/gh-link/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252436289,"owners_count":21747470,"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":["json-configuration","linkinbio","nextjs","vercel"],"created_at":"2024-12-13T11:27:50.421Z","updated_at":"2025-05-05T04:03:17.932Z","avatar_url":"https://github.com/1weiho.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Banner](https://user-images.githubusercontent.com/75478661/226669177-87319e12-f192-49fd-8cd4-8e4656daccc0.png)\n\n# GH Link\n\nGH Link is a Link in Bio website that can be configured with only a JSON file.\n\n## Usage\n\nTo use GH Link, follow these steps:\n\n1. Add a `gh-config.json` file to your special repository’s root (the repo with your username).\n2. Configure `gh-config.json` with the following format:\n\n   \u003e Note: icon is optional. If no icon is provided, the default link icon will be used.\n\n   ```json\n   {\n     \"links\": [\n       {\n         \"title\": \"GitHub\",\n         \"description\": \"GitHub Official Website\",\n         \"url\": \"https://github.com\",\n         \"icon\": \"https://cdn-icons-png.flaticon.com/512/25/25231.png\"\n       },\n       {\n         \"title\": \"Click me\",\n         \"description\": \"Surprise 😃\",\n         \"url\": \"https://www.youtube.com/watch?v=dQw4w9WgXcQ\"\n       }\n     ]\n   }\n   ```\n\n3. Done! Visit your own link website at `gh-link.vercel.app/YOUR_USERNAME`.\n\n## Running Locally\n\nTo run GH Link locally, follow these steps:\n\n1. Clone this repository:\n\n   ```bash\n   git clone https://github.com/davidho0403/gh-link\n   ```\n\n2. Store the API keys in `.env.local`:\n\n   ```bash\n   cp .env.example .env.local\n   ```\n\n3. Install the dependencies:\n\n   ```bash\n   npm install\n   ```\n\n4. Run the application:\n\n   ```bash\n   npm run dev\n   ```\n\n5. Finally, visit [http://localhost:3000](http://localhost:3000/) in your web browser.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F1weiho%2Fgh-link","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F1weiho%2Fgh-link","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F1weiho%2Fgh-link/lists"}