{"id":16208424,"url":"https://github.com/g-rath/webpack-serve-overlay","last_synced_at":"2025-03-19T08:30:45.833Z","repository":{"id":65412543,"uuid":"139199965","full_name":"G-Rath/webpack-serve-overlay","owner":"G-Rath","description":"Overlay for webpack-serve","archived":false,"fork":false,"pushed_at":"2018-09-02T04:03:14.000Z","size":31,"stargazers_count":10,"open_issues_count":4,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-17T05:05:20.747Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/G-Rath.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-06-29T22:03:54.000Z","updated_at":"2025-03-03T15:17:32.000Z","dependencies_parsed_at":"2023-01-22T08:05:38.379Z","dependency_job_id":null,"html_url":"https://github.com/G-Rath/webpack-serve-overlay","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/G-Rath%2Fwebpack-serve-overlay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/G-Rath%2Fwebpack-serve-overlay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/G-Rath%2Fwebpack-serve-overlay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/G-Rath%2Fwebpack-serve-overlay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/G-Rath","download_url":"https://codeload.github.com/G-Rath/webpack-serve-overlay/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244389699,"owners_count":20444986,"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-10-10T10:16:54.091Z","updated_at":"2025-03-19T08:30:45.205Z","avatar_url":"https://github.com/G-Rath.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# webpack-serve-overlay\n\nA rudimentary overlay for [`webpack-serve`](https://github.com/webpack-contrib/webpack-serve), based off the one used in `webpack-dev-server`.\n\nThis package is targeted at serves as a quick fully functional way of \nbeing able to have the same overlay as `webpack-dev-server` in `webpack-serve` with minimal fuss \u0026 expense.\n\n## Usage\n\nInstall the package:\n\n```\nnpm i webpack-serve-overlay\n```\n\nThen require the overlay at the top of your `index.jsx` (or equivalent):\n\n```javascript\n// becomes dead code in builds other than dev,\n// which webpack should pick up and remove.\nif(process.env.NODE_ENV === 'development') {\n    require('webpack-serve-overlay');\n}\n```\n\nand you'll be away laughing.\n\n## Configuration\n\nThe overlay works by using a WebSocket that connects to `webpack-serve` à la `webpack-hot-client`.  \nThis means that it *shouldn't* require any extra settings or configuration.\n\nHowever, just in case, you can manually specify the WebSocket url by setting the `WEBPACK_SERVE_OVERLAY_WS_URL` env property.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fg-rath%2Fwebpack-serve-overlay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fg-rath%2Fwebpack-serve-overlay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fg-rath%2Fwebpack-serve-overlay/lists"}