A TypeScript/Javascript BENNC implementation.

Go to file

Jack Hadrill 8a6a73206e Get history fix		2024-11-20 00:25:21 +00:00
.vscode	Add all BENNC message types with unit tests	2022-02-06 20:38:52 +00:00
src	Get history fix	2024-11-20 00:25:21 +00:00
tests	Fix outbound user data request/response	2022-03-18 22:31:50 +00:00
.drone.yml	Add git to drone.yml file.	2022-02-06 20:46:43 +00:00
.gitignore	Initial commit	2022-01-30 17:33:32 +00:00
LICENSE	Initial commit	2022-01-30 17:33:32 +00:00
README.md	TypeScript boilerplate.	2022-01-30 17:44:50 +00:00
package-lock.json	Return ciphertext rather than decrypted content	2022-03-18 15:56:33 +00:00
package.json	Return ciphertext rather than decrypted content	2022-03-18 15:56:33 +00:00
tsconfig.eslint.json	Initial progress	2022-02-01 02:12:49 +00:00
tsconfig.json	Update 'tsconfig.json'	2022-02-07 00:29:17 +00:00

README.md

BENNC-JS

An implementation of the BENNC client specification.

Build

To build the BENNC-JS library, first clone this repository.

Run the following commands from the root of the repository:

$ npm install
$ npm run build

The build output will be saved to the dist directory.

Development instructions

Requirements:

The latest LTS builds of Node and npm.

Follow the instructions below to lint, test and build BENNC-JS.

Lint

$ npm install
$ npm run lint

Test

$ npm install
$ npm run test

Build

$ npm install
$ npm run build

Visual Studio Code

This repository contains the necessary configuration files to debug, test and build BENNC-JS using only Visual Studio Code.

Run the build task (Ctrl+Shift+B or ⇧⌘B) to automatically compile the Typescript source files in the background.

Unit tests use the Jest library. Support for Visual Studio Code is offered through the Jest marketplace package maintained by Orta.

Contribution guidelines

This library uses ts-standard, based on JavaScript Standard Style. Please ensure all contributions are ts-standard compliant before submitting a pull request.