Skip to main content

Scripts

Run application in development mode​

caution

The app is using self-signed certificate since WebRTC supports only HTTPS connection so your web-browser will likely warn you about untrusted certificate. Feel free to skip this warning.

To start the application in a development mode, run the following command in the project folder:

yarn dev

The application will automatically open in the browser after running script.

The page will reload if you make edits.

Make a production build application​

yarn build

This command creates a production build in dist directory for each application.

See the section about deployment for more information.

tip

Be sure to use HTTPS on the server, otherwise video calls will not work for you.

Start API Server​

Runs the API server in a production mode.

yarn start:api

The API server will run on port 4000.

See the section about deployment for more information.

tip

Before launching the server API, it is necessary to make an application build

Start of documentation development​

To develop documentation, you can use the following command:

yarn start:doc

Start Integration Pages​

yarn start:pages

This script allows you to run integration pages on http://localhost:8000.

You can read more about how to work with integration pages here: Integration page

Run code linting​

yarn lint

This will run code linting using eslint which will analyze code to find problematic patterns or code that doesn't adhere to certain style guidelines.

Run configuration creation​

You can create a configuration file by running this command and following the instructions in the terminal:

yarn init:config

Run schema upload​

You can add the schema automatically by running this command and following the instructions in the terminal:

yarn init:schema