Giter Site home page Giter Site logo

shepherd-client's Introduction

shepherd-client

This modules provides the client side scripts necessary to run the new Webrecorder/oldweb-today browser system.

Usage

To use the default setup, simply include the prebuilt shepherd-client.bundle.js and call InitBrowserDefault() function

This will initialize a remote browser on page load.

A basic setup might look as follows:

<html>
  <head>
    <script src="/static/shepherd-client.bundle.js"></script>
    <script>
      InitBrowserDefault("{{ reqid }}", {"id": "browser"});
    </script>
  </head>
  <body>
    <div id="browser"></div>
  </body>
</html>

The reqid is an id of a requested browser from shepherd. It can be passed in from a server (the default) or created dynamically using the Shepherd API.

TODO: add more docs on how to use!

Building

To build the bundle (requires Node), run:

yarn install
yarn run build

(To build debug-friendly bundle run yarn run build-dev)

Importing Module

To embed a remote/containerized browser into an existing application, you can import the node module and use the CBrowser class:

import CBrowser from 'shepherd-client/src/browser';
...
let cb = new CBrowser(...)

shepherd-client's People

Contributors

humberthardy avatar ikreymer avatar m4rk3r avatar

Watchers

 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.