https://github.com/chrisguttandin/timing-provider-server

A command line tool to spin up a server which can be used with the timing-provider.
https://github.com/chrisguttandin/timing-provider-server

synchronisation timing timing-object timing-provider timingsrc webtiming

Last synced: 2 months ago
JSON representation

A command line tool to spin up a server which can be used with the timing-provider.

• Host: GitHub
• URL: https://github.com/chrisguttandin/timing-provider-server
• Owner: chrisguttandin
• License: mit
• Created: 2020-06-22T14:28:26.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-18T17:42:15.000Z (3 months ago)
• Last Synced: 2024-10-24T12:31:44.529Z (2 months ago)
• Topics: synchronisation, timing, timing-object, timing-provider, timingsrc, webtiming
• Language: JavaScript
• Size: 5.4 MB
• Stars: 15
• Watchers: 3
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# timing-provider-server

**A command line tool to spin up a server which can be used with the timing-provider.**

[![version](https://img.shields.io/npm/v/timing-provider-server.svg?style=flat-square)](https://www.npmjs.com/package/timing-provider-server)

This command line tool spins up a server which can be used as the signaling server for the [timing-provider](https://github.com/chrisguttandin/timing-provider). It is primarily intended for local testing.

## Usage

The timing-provider-server package is published on [npm](https://www.npmjs.com/package/timing-provider-server). It can be installed like this:

```shell

npm install timing-provider-server

```

Afterwards the server can be started by executing the following command:

```shell

timing-provider-server

```

It is also possible to run the command above without explicitly installing a local version of this package first like this:

```shell

npx timing-provider-server

```

Once the server is up and running it can be used when creating a new `TimingProvider`.

```js

const timingProvider = new TimingProvider('ws://localhost:2276');

```

## Arguments

### --port

This option can be used to specify the port to which the server is listening. If this argument is not used 2276 will be used as the default port.

```shell

timing-provider-server --port 4567

```