# reveal-socket-remote

> Reveal.js socket io remote server with plugin

Latest version **1.4.0** (published 2019-05-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install reveal-socket-remote
pnpm add reveal-socket-remote
yarn add reveal-socket-remote
bun add reveal-socket-remote
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.0 |
| Published | 2019-05-26 |
| First published | 2019-05-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 19.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Nils Bergmann |
| Maintainers | noim |

## Links

- npm: https://www.npmjs.com/package/reveal-socket-remote
- Repository: https://github.com/TheNoim/reveal-presentation-remote
- npm.io page: https://npm.io/package/reveal-socket-remote

## Dependencies (5)

- [lodash](https://npm.io/package/lodash.md) ^4.17.11
- [clientjs](https://npm.io/package/clientjs.md) ^0.1.11
- [random-words](https://npm.io/package/random-words.md) ^1.1.0
- [socket.io-client](https://npm.io/package/socket.io-client.md) ^2.2.0
- [vue-socket.io-extended](https://npm.io/package/vue-socket.io-extended.md) ^3.2.1

## Recent versions

- 1.4.0 (latest) — 2019-05-26
- 1.3.5 — 2019-05-26
- 1.3.4 — 2019-05-26
- 1.3.3 — 2019-05-26
- 1.3.2 — 2019-05-26
- 1.3.1 — 2019-05-26
- 1.3.0 — 2019-05-26
- 1.2.0 — 2019-05-07
- 1.1.1 — 2019-05-07
- 1.1.0 — 2019-05-07
- 1.0.2 — 2019-05-05
- 1.0.1 — 2019-05-05
- 1.0.0 — 2019-05-05

## README

# Reveal Remote

Build with socket.io and fastify.

## Usage

1. Clone this repo
2. Install dependencies:

	```bash
    # With yarn
    yarn
    # or with npm
    npm install
   ```
3. Run server

	```bash
    node server/index.js --port 1337 --host 0.0.0.0
   ```
4. Setup your presentation

    1. Setup your reveal project
    2. Install this from npmmn

		```bash
       # With yarn
       yarn add reveal-socket-remote
       # or with npm
       npm install reveal-socket-remote --save 
		```

    3. Import the plugin

		```javascript
		// Setup your reveal stuff
		// [...]
		// Then import my plugin
		const { initRemoteSocket } = require('reveal-socket-remote');
		// Now you can init the connection
		// The first argument needs to be the Reveal instance
		initRemoteSocket(Reveal, 'your server address here')
		```

---
_Source: https://npm.io/package/reveal-socket-remote · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._