https://github.com/papercups-io/storytime

Screen sharing plugin for Papercups
https://github.com/papercups-io/storytime

fullstory hotjar logrocket papercups session-replay storytime

Last synced: about 1 month ago
JSON representation

Screen sharing plugin for Papercups

• Host: GitHub
• URL: https://github.com/papercups-io/storytime
• Owner: papercups-io
• Created: 2020-10-14T19:02:56.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-07-08T16:47:34.000Z (over 4 years ago)
• Last Synced: 2025-09-01T23:47:19.666Z (about 1 month ago)
• Topics: fullstory, hotjar, logrocket, papercups, session-replay, storytime
• Language: TypeScript
• Homepage:
• Size: 113 KB
• Stars: 25
• Watchers: 4
• Forks: 13
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# @papercups-io/storytime

> Papercups screen sharing feature

[![NPM](https://img.shields.io/npm/v/@papercups-io/storytime.svg)](https://www.npmjs.com/package/@papercups-io/storytime) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Demo

**Screenshot:**



**GIF:**

![demo](https://user-images.githubusercontent.com/5264279/96898977-56c27d00-145e-11eb-907b-ca8db13a0fa0.gif)

## Install

```bash

npm install --save @papercups-io/storytime

```

## Usage

First, sign up at https://app.papercups.io/register to get your account token. Your account token is what you will use to pass in as the `accountId` prop below.

### Using in HTML

Paste the code below between your `` and `` tags:

```html

  window.Papercups = {

    config: {

      // Pass in your Papercups account token here after signing up

      accountId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx',

      // Optionally pass in metadata to identify the customer

      customer: {

        name: 'Test User',

        email: 'test@test.com',

        external_id: '123',

      },

      // Optionally specify the base URL

      baseUrl: 'https://app.papercups.io',

    },

  };

```

_:warning: **Note** that if you already have included the `window.Papercups` configuration with the [chat widget](https://github.com/papercups-io/chat-widget#using-in-html), you should **NOT** duplicate it here!_

If you **already** have the config set, just include this script below it:

```html

```

### Using as an NPM module

Place the code below in any pages on which you would like to render the widget. If you'd like to render it in all pages by default, place it in the root component of your app.

```tsx

import {Storytime} from '@papercups-io/storytime';

const st = Storytime.init({

  // Pass in your Papercups account token here after signing up 

  accountId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx',

  // Optionally specify the base URL

  baseUrl: 'https://app.papercups.io',

});

// If you want to stop the session recording manually, you can call:

// st.finish();

// Otherwise, the recording will stop as soon as the user exits your website.

```