toreda / headless

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ArmorJS - Headless

Headless Browser for automated testing

CI Coverage Quality Gate Status

Contents

About ArmorJS

ArmorJS solves unique challenges in the enterprise node ecosystem. Auditing projects for security, reliability, and even license compatibility are monumental tasks when a project includes thousands of frequently changing dependencies.

ArmorJS standards:

  • Full typescript support.
  • Consistent API between releases.
  • Extremely small footprint (for webpacking).
  • No more than 5 external dependencies (excluding dev dependencies).
  • Compatible with web, node, and serverless deployment.
  • Thorough test coverage.
  • MIT License.

Install

With yarn (preferred): yarn add @armorjs/headless

With NPM: npm install @armorjs/headless

Usage

Library Usage

Typescript

import { ArmorHeadless } from '@armorjs/headless';

Node

const ArmorHeadless = require('@armorjs/headless');

Build

Build (or rebuild) the config package:

With Yarn (preferred):

yarn install
yarn build

With NPM:

npm install
npm run-script build

Testing

Headless implements unit tests using jest. Run the following commands from the directory where headless has been installed.

With yarn (preferred):

yarn install
yarn test

With NPM:

npm install
npm run-script test

License

MIT © Michael Brich

About

License:MIT License


Languages

Language:TypeScript 88.7%Language:HTML 9.3%Language:JavaScript 2.1%