{"id":30739003,"url":"https://github.com/tobycm/qr-code-generator-server","last_synced_at":"2025-09-03T22:44:03.033Z","repository":{"id":295705593,"uuid":"850480647","full_name":"tobycm/qr-code-generator-server","owner":"tobycm","description":"A server to generate QR codes XD","archived":false,"fork":false,"pushed_at":"2024-09-01T02:46:19.000Z","size":14,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-29T23:49:09.142Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tobycm.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,"zenodo":null}},"created_at":"2024-08-31T22:22:26.000Z","updated_at":"2024-09-01T02:46:22.000Z","dependencies_parsed_at":"2025-05-27T00:56:19.046Z","dependency_job_id":"11194e16-a782-4bc3-8794-53f5cd8874f9","html_url":"https://github.com/tobycm/qr-code-generator-server","commit_stats":null,"previous_names":["tobycm/qr-code-generator-server"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/tobycm/qr-code-generator-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tobycm%2Fqr-code-generator-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tobycm%2Fqr-code-generator-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tobycm%2Fqr-code-generator-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tobycm%2Fqr-code-generator-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tobycm","download_url":"https://codeload.github.com/tobycm/qr-code-generator-server/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tobycm%2Fqr-code-generator-server/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273523644,"owners_count":25120864,"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","status":"online","status_checked_at":"2025-09-03T02:00:09.631Z","response_time":76,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2025-09-03T22:43:43.253Z","updated_at":"2025-09-03T22:44:03.024Z","avatar_url":"https://github.com/tobycm.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# QR Code Generator Server\n\nA simple API server for generating QR codes.\n\n## 💪 Features\n\n- ✅ Asynchronous QR code generation\n- ✅ Fast and lightweight\n- ✅ Different formats (PNG, SVG, etc.)\n- ✅ Customizable QR code size, color, etc\n\n## 🚀 Getting Started\n\n### Prerequisites\n\n- [Bun](https://bun.sh)\n\n### Step 1\n\nClone the repository\n\n```sh {\"id\":\"01J6K7HS08C87M42HE07X7GXAY\"}\ngit clone https://github.com/tobycm/qr-code-generator-server\ncd qr-code-generator-server\n```\n\n### Step 2\n\nInstall the dependencies\n\n```sh {\"id\":\"01J6K7JKVY7RS3486R0TW8XXAG\"}\nbun i\n```\n\n### Step 3\n\nStart the server\n\n```sh {\"id\":\"01J6K7P605DHZ0FABRMZHVTPZ3\"}\nbun run start\n```\n\n## API Docs 😭\n\n### `GET /`\n\nReturns a message:\n\n```json\n{\n  \"message\": \"Hello World\"\n}\n```\n\n### `POST /qr`\n\nGenerates a QR code.\n\n### Request body\n\nAny text data\n\nExamples:\n```\nhttps://tobycm.dev\n```\n\n### Request query parameters\n\n- `format`\n\n    The format of the QR code. Default is `png`.\n    \n    Supported formats:\n    - `png`\n    - `svg`\n    - `utf8` (try it out xd)\n\n- `margin`\n\n    The margin of the QR code. Default is `4`.\n\n- `errorCorrection`\n\n    The error correction level of the QR code. Default is `M`.\n\n    Supported error correction levels:\n    - `L`\n    - `M`\n    - `Q`\n    - `H`\n\n- `scale`\n\n    The pixel per block of the QR code. Default is `4`.\n\n- `width`\n\n    The width of the QR code. Overrides `scale`.\n\n- `background`\n\n    The background color of the QR code in RGBA. Default is `#ffffffff`.\n\n- `foreground`\n\n    The foreground color of the QR code in RGBA. Default is `#000000ff`.\n\n### Response\n\nHeaders:\n- `Content-Type`\n\n    The content type of the QR code. Based on the `format` query parameter.\n\nBody:\n\nThe QR code image or text data.\n\n\n### Example\n\nRequest:\n```\nPOST /qr?format=svg\u0026margin=8\u0026errorCorrection=H\u0026scale=8\u0026background=%23ff0000ff\u0026foreground=%2300ff00ff\n```\n\nBody:\n```\nhttps://tobycm.dev\n```\n\nResponse:\n![qr that loads to https://tobycm.dev with a red background and green foreground in svg format](examples/tobycm.dev.qr.svg)\n\n\n## 📚 Tech Stack\n\n- [Bun](https://bun.sh)\n- [node-qrcode](https://www.npmjs.com/package/qrcode)\n- [TypeScript](https://www.typescriptlang.org)\n\n## 📝 License\n\nThis project is licensed under the MIT License - see the [`LICENSE`](LICENSE) file for details.\n\n## 🤝 Contributions\n\nAny contribution is appreciated. Just create an issue/pull request and I will review it ASAP.\n\n## 🔗 Share this project\n\nIf you like this project, please give it a ⭐ and share it with your friends!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftobycm%2Fqr-code-generator-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftobycm%2Fqr-code-generator-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftobycm%2Fqr-code-generator-server/lists"}