Giter Club home page Giter Club logo

browser-sync's Introduction

browser-sync Build Status NPM version Built with Grunt

Keep multiple browsers & devices in sync when building websites.

Follow @browserSync for news & updates. Check out the website too.

##Features

  1. Scroll - I can keep your pages in sync when scrolling.
  2. Forms - You fill out a form in one browser, I'll copy the data to all the others.
  3. Links - I'll watch your clicks & and make all the other browsers follow you.
  4. CSS injecting - I can even watch your CSS files & inject them when they change.
  5. Live Reload - I can also watch files like HTML and PHP & when they change I can reload all browsers for you.
  6. Built-in Server - Yep, I can serve static files too if you need me to (uses Connect).
  7. Use with any back-end setup - Browser-sync includes a proxy option so that it can be used with any existing PHP, Rails, Python, Node or ASP.net setup.

##When is it useful? It's pretty useful when used with a single browser, watching a CSS file for changes & injecting it. But the real power comes when you're building responsive sites and using multiple devices/monitors because it can keep all browsers in sync & make your workflow much faster.

##Install

npm install -g browser-sync

##How to use it There are currently 2 ways to use browser-sync - with a config file & without a config file. Both options are explained on the following pages.

  1. With a config file
  2. Command line only (no config file)

Using Grunt?

There's a separate plugin for that

Using Gulp?

No problem, here's a setup guide

##Screencasts ( < 3 min each )

  1. Using the Static Server with css injecting
  2. Keeping browsers at the same scroll position
  3. Keeping form fields in sync
  4. When should you use the built-in server?

+ Laravel (php)

  1. Browser Sync + Laravel 4 (php server & proxy)
  2. Browser Sync + Laravel 4 (Mamp Pro & proxy)
  3. Browser Sync + Laravel 4 (Config file & Proxy)
  4. Browser Sync + Laravel 4 (Config file & no proxy)

+ Vagrant

  1. Browser Sync + Vagrant

Want any more? Something specific? ask me nicely @shaneOsbourne

##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 Gittip Support via PayPal

##Contributors

Commits Name
293 Shane Osbourne
11 Hugo Bessa
2 brutaldev
2 chase_chou
1 Sylvain Emery
1 Tony Holdstock-Brown
1 Werner van Deventer
1 mericson
1 Carl Henderson
1 viktor hesselbom
1 Dave Hall
1 Jory Graham
1 Robert Vock

License

Copyright (c) 2013 Shane Osbourne Licensed under the MIT license.

browser-sync's People

Contributors

shakyshane avatar brutaldev avatar chasechou avatar d-g-h avatar jory avatar rvock avatar sylvainemery avatar tonyhb avatar mericson avatar hesselbom avatar

Watchers

James Cloos avatar Konstantinos Tsatsarounos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.