browser-sync - GitLite

KO | EN

gitlite — search

#javascript #react #llm #go #rust #linux #docker #macos #windows #awesome #awesome-list #mcp #openai #ios

browser-sync

(★ 12,290)

Keep multiple browsers & devices in sync when building websites. https://browsersync.io

File Explorer

Download Latest Version (.zip)

- - main.yml
- - run.js
- - index.html
  - run.js
- 404.js
- callback.js
- express.js
- less.js
- middleware.css.injection.js
- notify-styles.js
- options.snippetOptions.js
- proxy.gzip.js
- proxy.headers.js
- proxy.localhost.js
- proxy.middleware.js
- proxy.middleware.multi.js
- proxy.proxyRes.js
- proxy.rewriteRules.advanced.js
- proxy.rewriteRules.simple.js
- proxy.secure.js
- proxy.vhost.js
- server.basedir.js
- server.basedir.mulitple.js
- server.default.js
- server.gzip.js
- server.http2.js
- server.latency.js
- server.middleware.js
- server.middleware.multiple.js
- server.proxy.js
- server.secure.js
- server.secure.pfx.js
- server.watch.js
- - .gitignore
  - .prettierignore
  - lodash.custom.min.js
  - package-lock.json
  - package.json
  - readme.md
  - tsconfig.json
- - .gitignore
  - .travis.yml
  - index.js
  - LICENSE-MIT
  - package-lock.json
  - package.json
  - README.md
  - tsconfig.json
  - webpack.config.js
- - .editorconfig
  - .gitignore
  - .jshintrc
  - crossbow.yaml
  - example.stream.js
  - index.js
  - LICENSE
  - package-lock.json
  - package.json
  - README.md
  - webpack.config.js
- utils.ts
.editorconfig
.gitattributes
.gitignore
.travis.yml
changelog.js
CONTRIBUTING.md
ISSUE_TEMPLATE.md
lerna.json
LICENSE
nx.json
package-lock.json
package.json
playwright.config.ts
README.md

🚀 Installation Guide

1. Get the code

git clone https://github.com/BrowserSync/browser-sync

Downloads the entire project code from GitHub to your computer.

cd browser-sync

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
<a href="https://www.npmjs.com/package/browser-sync" title="NPM version">
 <img src="https://img.shields.io/npm/v/browser-sync.svg?style=flat-square" />
</a>
<a href="https://www.npmjs.com/package/browser-sync">
 <img src="https://img.shields.io/npm/dm/browser-sync.svg?style=flat-square" />
</a>
</p>
<p align="center"><a href="https://www.browsersync.io"><img src="https://raw.githubusercontent.com/BrowserSync/browsersync.github.io/master/public/img/logo-gh.png" /></a></p>
<p align="center">Keep multiple browsers & devices in sync when building websites.</p>
<p align="center">Follow <a href="https://twitter.com/browsersync">@Browsersync</a> on twitter for news & updates.</p>
<p align="center">Ask questions on <a href="https://discord.gg/2d2xUThp">Discord</a></p>

## Features

Please visit [browsersync.io](https://browsersync.io) for a full run-down of features

## Requirements

Browsersync works by injecting an asynchronous script tag (`<script async>...</script>`) right after the `<body>` tag
during initial request. In order for this to work properly the `<body>` tag must be present. Alternatively you
can provide a custom rule for the snippet using [snippetOptions](https://www.browsersync.io/docs/options/#option-snippetOptions)

## Upgrading from 1.x to 2.x ?
Providing you haven't accessed any internal properties, everything will just work as
there are no breaking changes to the public API. Internally however, we now use an
immutable data structure for storing/retrieving options. So whereas before you could access urls like this...

```js
browserSync({server: true}, function(err, bs) {
  console.log(bs.options.urls.local);
});
```

... you now access them in the following way:

```js
browserSync({server: true}, function(err, bs) {
  console.log(bs.options.getIn(["urls", "local"]));
});
```

## Install and trouble shooting

[browsersync.io docs](https://browsersync.io)

## Integrations / recipes

[Browsersync recipes](https://github.com/Browsersync/recipes)

## Support

If you've found Browser-sync useful and would like to contribute to its continued development & support, please feel free to send a donation of any size - it would be greatly appreciated!

[Support via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=shakyshane%40gmail%2ecom&lc=US&item_name=browser%2dsync)

## Supported by

Originally supported by [JH](https://www.wearejh.com) - they provided financial support as well as access to a professional designer to help with Branding.

Apache 2
Copyright (c) 2021 Shane Osbourne