1.7 KiB
Romulus-JS
An implementation of the Romulus-M cryptography specification.
Build
To build the Romulus-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.
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.
Development instructions
Requirements:
- The latest LTS builds of Node and npm.
Follow the instructions below to lint, test and build Romulus-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 Romulus-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.