BUILDING.md

What you need to build SIP.js

You just need to have Node.js and Git.

Development is currently being done using Node.js version 16.

How to build SIP.js

Clone a copy of the main SIP.js git repository by running:

$ git clone https://github.com/onsip/SIP.js.git

Enter the directory

$ cd SIP.js

Install the Node.js dependencies:

$ npm install

Build and test

$ npm run build-and-test

The compiled version of SIP.js will be available in the lib/ folder. The bundled versions of SIP.js will be available in the dist/ subdirectory in both flavors. There are copies of each file with the version number in the title in that subdirectory as well.

Development

Run npm run build-lib to regenerate the lib folder.

Tests

SIP.js includes integration and units implemented using Jasmine. Run the tests as follows:

$ npm run test

or

$ npm run browser-test

Changes in SIP.js grammar

If you modify src/grammar/src/grammar.pegjs you will need to recompile SIP.js grammar files. For that run the following task:

$ npm run generate-grammar