{"id":20073538,"url":"https://github.com/ragingwind/pwa-manifest","last_synced_at":"2025-08-06T11:17:45.138Z","repository":{"id":6886655,"uuid":"55196998","full_name":"ragingwind/pwa-manifest","owner":"ragingwind","description":"Create a Web Manifest for Progressive Manifest with a variety of options","archived":false,"fork":false,"pushed_at":"2022-02-13T20:02:04.000Z","size":1015,"stargazers_count":12,"open_issues_count":4,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-23T05:48:45.287Z","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/ragingwind.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":"2016-04-01T02:15:20.000Z","updated_at":"2021-06-21T11:45:47.000Z","dependencies_parsed_at":"2022-08-06T20:00:56.196Z","dependency_job_id":null,"html_url":"https://github.com/ragingwind/pwa-manifest","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/ragingwind/pwa-manifest","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ragingwind%2Fpwa-manifest","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ragingwind%2Fpwa-manifest/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ragingwind%2Fpwa-manifest/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ragingwind%2Fpwa-manifest/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ragingwind","download_url":"https://codeload.github.com/ragingwind/pwa-manifest/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ragingwind%2Fpwa-manifest/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269068041,"owners_count":24354406,"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-08-06T02:00:09.910Z","response_time":99,"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":"2024-11-13T14:46:40.592Z","updated_at":"2025-08-06T11:17:45.089Z","avatar_url":"https://github.com/ragingwind.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pwa-manifest [![Build Status](https://travis-ci.org/ragingwind/pwa-manifest.svg?branch=master)](https://travis-ci.org/ragingwind/pwa-manifest)\n\n\u003e Creating a Web Manifest for Progressive Web App with a variety of options\n\n\n## Install\n\n```\n$ npm install --save @pwa/manifest\n```\n\n\n## Usage\n\n```js\nconst pwaManifest = require('@pwa/manifest');\n\n(async () =\u003e {\n\tconst manifest = await pwaManifest({\n\t\tname: 'My PWApp',\n\t\tshort_name: 'My Short PWA Name',\n\t\tstart_url: '/index.html?homescreen=1',\n\t\tdisplay: 'standalone',\n\t\tbackground_color: '#EFEFEF',\n\t\ttheme_color: '#FFEEFF'\n\t})\n\t// dump new generated manifest file if you want\n\tawait pwaManifest.write('./', manifest);\n})();\n```\n\nor we support decamelizing from camelized properties\n\n```js\n(async () =\u003e {\n\tconst manifest = await pwaManifest({\n\t\tname: 'My PWApp',\n\t\tshortName: 'My Short PWA Name',\n\t\tstartUrl: '/index.html?homescreen=1',\n\t\tdisplay: 'standalone',\n\t\tbackgroundColor: '#EFEFEF',\n\t\tthemeColor: '#FFEEFF'\n\t});\n})();\n```\n\n\n## API\n\n### pwaManifest([options])\n\n#### options\n\nType: `object`\n\nWeb Manifest properties you want to set. The name of options are same as member property of Web Manifest. Icons sizes are followed in [lighthouse audits](https://github.com/GoogleChrome/lighthouse/tree/9f91ab405ca89882f40a71c6aef5dc6dc08543b4/lighthouse-core/audits)\n```\n{\n  \"name\": \"My Powerful Progressive Web App\",\n  \"short_name\": \"PWApp\",\n  \"icons\": [{\n    \"src\": \"icon-144x144.png\",\n    \"sizes\": \"144x144\",\n    \"type\": \"image/png\"\n  }, {\n    \"src\": \"icon-192x192.png\",\n    \"sizes\": \"192x192\",\n    \"type\": \"image/png\"\n  }, {\n    \"src\": \"icon-512x512.png\",\n    \"sizes\": \"512x512\",\n    \"type\": \"image/png\"\n  }],\n  \"start_url\": \"/index.html?homescreen=1\",\n  \"display\": \"standalone\",\n  \"background_color\": \"#FFFFFF\",\n  \"theme_color\": \"#3F51B5\"\n}\n```\n\n### pwaManifest.write(dir, manifest)\n\nReturns a promise.\n\n### pwaManifest.writeSync(dir, manifest)\n\nWrite a manifest file as `manifest.json` to dest path.\n\n### pwaManifest.read(dir)\n\nReturns a promise.\n\n### pwaManifest.readSync(dir)\n\nRead a manifest file in the name of `manifest.json` to src path\n\n## License\n\nMIT © [Jimmy Moon](http://ragingwind.me)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fragingwind%2Fpwa-manifest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fragingwind%2Fpwa-manifest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fragingwind%2Fpwa-manifest/lists"}