Node BACstack Browser

A BACnet browser using Electron, Angular and Node BACstack.

Note: This is an early prototype and shall not be considered as stable. Use it with caution and at your own risk!

Usage

Start Node BACstack Browser by using:

git clone https://github.com/fh1ch/node-bacstack-browser.git

cd node-bacstack-browser
npm i

npm start

Note: If the application window appears as a blank page, force refresh the page using F5 (Windows) or CMD+R (OSX).

Contributing

Any help is appreciated, from creating issues, to contributing documentation, fixing issues and adding new features.

Please follow the best-practice contribution guidelines as mentioned below when submitting any changes.

Conventional Changelog

This module has a changelog which is automatically generated based on Git commit messages. This mechanism requires that all commit messages comply with the Conventional Changelog. You can check if your commit messages complies with those guidelines by using:

npm run changelog

Code Style

This module uses TSLint with the Angular-CLI default settings for code linting. You can test if your changes comply with the code style by executing:

npm run lint

Testing and Coverage

Testing is done using Karama and Protractor, both provided by the Angular-CLI.

The test-coverage is automatically calculated using Istanbul. Running the tests and calculating the coverage can be done locally by executing:

npm run test && npm run e2e

It is expected that new features or fixes do not negatively impact the test results or the coverage.

License

The MIT License

fh1ch / node-bacstack-browser

readme