An implementation of the Romulus-M cryptography specification.

Go to file

Jack Hadrill f86515ab26 continuous-integration/drone/push Build is failing Details Update readme		2022-01-29 14:02:24 +00:00
.vscode	Project setup	2022-01-29 11:33:05 +00:00
src	Boilerplate TS project.	2022-01-29 10:57:04 +00:00
.drone.yml	Add support for CI	2022-01-29 11:43:08 +00:00
.gitignore	Project setup	2022-01-29 11:33:05 +00:00
LICENSE	Initial commit	2022-01-29 10:31:20 +00:00
README.md	Update readme	2022-01-29 14:02:24 +00:00
package-lock.json	Project setup	2022-01-29 11:33:05 +00:00
package.json	Add support for CI	2022-01-29 11:43:08 +00:00
tsconfig.json	Project setup	2022-01-29 11:33:05 +00:00

README.md

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.