Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 908 Bytes

README.md

File metadata and controls

42 lines (30 loc) · 908 Bytes

slidev-sync-server

WebSocket server for Slidev.

You can use this server easily with the slidev-addon-sync addon.

Installation

Get source code or git clone this repo.

Install dependencies:

npm i

Then build the files:

npm run build

Finally start the server:

npm run start

Configuration

You can configure the project using environment variables.

Example:

DEBUG=info npm run start

Available environment variables:

Variable Type Default value Description
PORT number 8080 Change running port
DEBUG 'error' | 'warn' | 'info' 'error' Debug level
WS boolean false use WebSocket if true, else use HTTP Server Sent Events
CORS_ORIGIN string '*' Access-Control-Allow-Origin header for HTTP SSE