Skip to content

Latest commit

 

History

History
67 lines (43 loc) · 1.87 KB

BUILDING.md

File metadata and controls

67 lines (43 loc) · 1.87 KB
Raw

What you need to build SIP.js

You just need to have Node.js and Git. Optionally you also need PhantomJS if you want to run test units.

Node.js

Git

PhantomJS

(optional, just for running unit tests)

  • Install PhantomJS
  • In modern Debian/Ubuntu systems PhantomJS can be installed via apt-get install phantomjs

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 and install the Node.js dependencies:

$ cd SIP.js && npm install

Build and test

$ npm run build && npm run commandLineTest

The built version of SIP.js will be available in the dist/ subdirectory in both flavors: normal (uncompressed) and minified, both linted with ESLint. There are copies of each file with the version number in the title in that subdirectory as well.

Development version

Run npm run build for just generating the dist/sip.js file. An uncompressed SIP.js source file named sip.js will be created in dist directory.

Test units

SIP.js includes test units based on Jasmine. Test units use the dist/sip.js file. Run the tests as follows:

$ npm run commandLineTest
$ npm run browserTest

Running "jasmine:components" (jasmine) task
Testing jasmine specs via phantom
...
672 specs in 2.757s.
>> 0 failures

Changes in SIP.js grammar

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

$ npm run build