12.3K ·GitHub
What is this?
BrowserSync is a developer tool that keeps multiple browsers and devices in sync while you build websites — actions in one browser are mirrored in the others as you work.
BrowserSync is a developer tool that keeps multiple browsers and devices in sync while you build websites — actions in one browser are mirrored in the others as you work.Is it a tool I run while developing, or a library I code against?Both sides exist: it ships as an npm package with a command-line interface, and it also exposes a public API that other code and integrations can build on.
Both sides exist: it ships as an npm package with a command-line interface, and it also exposes a public API that other code and integrations can build on.How do I get it running on my machine?Install the npm package (npm install -g browser-sync), then follow the install and troubleshooting guide on browsersync.io for getting started.
Install the npm package (npm install -g browser-sync), then follow the install and troubleshooting guide on browsersync.io for getting started.Do I need Node.js or anything else installed first?Yes — it is distributed through npm as a JavaScript package, so Node.js and npm must be on your machine; installing also pulls its runtime dependencies such as rxjs.
Yes — it is distributed through npm as a JavaScript package, so Node.js and npm must be on your machine; installing also pulls its runtime dependencies such as rxjs.I'm on 1.x — does upgrading to 2.x break anything?No, as long as you have not accessed internal properties: there are no breaking changes to the public API. Only the internal option storage changed, so urls are read differently.
No, as long as you have not accessed internal properties: there are no breaking changes to the public API. Only the internal option storage changed, so urls are read differently.How does BrowserSync get into my pages?It works through a snippet tag in your page — the tag must be present for syncing to work, and you can provide a custom rule for the snippet via snippetOptions if you need to.
It works through a snippet tag in your page — the tag must be present for syncing to work, and you can provide a custom rule for the snippet via snippetOptions if you need to.Are there ready examples of integrating it with build tools?Yes — the README links to 'Browsersync recipes', a collection of ready-made integration examples for common setups.
Yes — the README links to 'Browsersync recipes', a collection of ready-made integration examples for common setups.Is it free to use, and how is development supported?It is free, released under the Apache 2.0 license. The author accepts donations of any size via PayPal to support continued development.
It is free, released under the Apache 2.0 license. The author accepts donations of any size via PayPal to support continued development.What are similar projects?less.js, yeoman, gopherjs, jquery, critical, closure-compiler, mustache.js, bb-browser
less.js, yeoman, gopherjs, jquery, critical, closure-compiler, mustache.js, bb-browserWhich topics is it in?cross-browser, real-time, browser, web-development, npm, frontend, automation, tool, apache-2.0, nodejs, javascript, cli
cross-browser, real-time, browser, web-development, npm, frontend, automation, tool, apache-2.0, nodejs, javascript, cli