https://github.com/toreda/headless
https://github.com/toreda/headless
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/toreda/headless
- Owner: toreda
- License: mit
- Created: 2020-11-24T19:06:37.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-29T08:07:21.000Z (about 2 months ago)
- Last Synced: 2025-03-29T09:21:37.751Z (about 2 months ago)
- Language: TypeScript
- Size: 455 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ArmorJS - Headless
## Headless Browser for automated testing
 [](https://sonarcloud.io/dashboard?id=armorjs_headless) [](https://sonarcloud.io/dashboard?id=armorjs_headless)
## Contents
- [About ArmorJS](#about-armorjs)
- [Installation](#Installation)
- [Usage](#usage)
- [Build](#build)
- [Testing](#testing)
- [License](#license)
## 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](LICENSE) © Michael Brich