{"id":13805527,"url":"https://github.com/LostInBrittany/granite-qrcode-generator","last_synced_at":"2025-05-13T19:31:19.961Z","repository":{"id":12331699,"uuid":"71563988","full_name":"LostInBrittany/granite-qrcode-generator","owner":"LostInBrittany","description":"A webcomponent to render a QR Code","archived":false,"fork":false,"pushed_at":"2023-03-05T06:52:03.000Z","size":5448,"stargazers_count":12,"open_issues_count":9,"forks_count":9,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-07T12:52:53.516Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/LostInBrittany.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":"2016-10-21T12:41:34.000Z","updated_at":"2024-01-22T12:31:18.000Z","dependencies_parsed_at":"2024-04-09T22:50:45.041Z","dependency_job_id":"6671d941-2585-4124-9111-4069acf2ce30","html_url":"https://github.com/LostInBrittany/granite-qrcode-generator","commit_stats":{"total_commits":23,"total_committers":5,"mean_commits":4.6,"dds":"0.17391304347826086","last_synced_commit":"124ee9a5250dcdc07cf61df390f9048511ab653e"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LostInBrittany%2Fgranite-qrcode-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LostInBrittany%2Fgranite-qrcode-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LostInBrittany%2Fgranite-qrcode-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LostInBrittany%2Fgranite-qrcode-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LostInBrittany","download_url":"https://codeload.github.com/LostInBrittany/granite-qrcode-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225110575,"owners_count":17422411,"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-08-04T01:01:01.985Z","updated_at":"2024-11-18T21:31:20.903Z","avatar_url":"https://github.com/LostInBrittany.png","language":"JavaScript","funding_links":[],"categories":["Standalone Components"],"sub_categories":[],"readme":"[![Published on Vaadin  Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/LostInBrittanygranite-qrcode-generator)\n[![Stars on vaadin.com/directory](https://img.shields.io/vaadin-directory/star/LostInBrittanygranite-qrcode-generator.svg)](https://vaadin.com/directory/component/LostInBrittanygranite-qrcode-generator)\n[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/LostInBrittany/granite-qrcode-generator)\n\n# \\\u003cgranite-qrcode-generator\u003e\n\nA custom element to generate and render a QR Codes, using [qr.js](https://github.com/lifthrasiir/qr.js) library\n\nBuilt on [lit-element](https://github.com/Polymer/lit-element) following the [open-wc](https://github.com/open-wc/open-wc) recommendation.\n\n\u003e The old Polymer 2.x-1.x version is available on the [`polymer-hybrid` branch](https://github.com/LostInBrittany/granite-qrcode-generator/tree/polymer-hybrid).\n\n## Installation\n```bash\nnpm i @granite-elements/granite-qrcode-generator\n```\n\n## Usage\n```html\n\u003cscript type=\"module\"\u003e\n  import 'granite-qrcode-generator/granite-qrcode-generator.js';\n\u003c/script\u003e\n\n\u003cgranite-qrcode-generator \n    data=\"https://github.com/lostinbrittany/granite-elements\"\n    mode=\"alphanumeric\"\n    auto\u003e\u003c/granite-qrcode-generator\u003e\n```\n\n## Linting with ESLint, Prettier, and Types\nTo scan the project for linting errors, run\n```bash\nnpm run lint\n```\n\nYou can lint with ESLint and Prettier individually as well\n```bash\nnpm run lint:eslint\n```\n```bash\nnpm run lint:prettier\n```\n\nTo automatically fix many linting errors, run\n```bash\nnpm run format\n```\n\nYou can format using ESLint and Prettier individually as well\n```bash\nnpm run format:eslint\n```\n```bash\nnpm run format:prettier\n```\n\n## Testing with Karma\nTo run the suite of karma tests, run\n```bash\nnpm run test\n```\n\nTo run the tests in watch mode (for \u003cabbr title=\"test driven development\"\u003eTDD\u003c/abbr\u003e, for example), run\n\n```bash\nnpm run test:watch\n```\n\n## Demoing with Storybook\nTo run a local instance of Storybook for your component, run\n```bash\nnpm run storybook\n```\n\nTo build a production version of Storybook, run\n```bash\nnpm run storybook:build\n```\n\n\n## Tooling configs\n\nFor most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.\n\nIf you customize the configuration a lot, you can consider moving them to individual files.\n\n## Local Demo with `es-dev-server`\n```bash\nnpm start\n```\nTo run a local development server that serves the basic demo located in `demo/index.html`\n\n\n\n\n## Contributing\n\n1. Fork it!\n2. Create your feature branch: `git checkout -b my-new-feature`\n3. Commit your changes: `git commit -m 'Add some feature'`\n4. Push to the branch: `git push origin my-new-feature`\n5. Submit a pull request :D\n\n## License\n\n[MIT License](http://opensource.org/licenses/MIT)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FLostInBrittany%2Fgranite-qrcode-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FLostInBrittany%2Fgranite-qrcode-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FLostInBrittany%2Fgranite-qrcode-generator/lists"}