Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/copperjs/copper
A blazing fast chrome grid
https://github.com/copperjs/copper
Last synced: 3 days ago
JSON representation
A blazing fast chrome grid
- Host: GitHub
- URL: https://github.com/copperjs/copper
- Owner: copperjs
- License: mit
- Created: 2021-06-28T23:22:34.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-07-06T06:31:26.000Z (over 3 years ago)
- Last Synced: 2024-05-02T05:03:56.221Z (6 months ago)
- Language: TypeScript
- Size: 9.38 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-blazingly-fast - copper - A blazing fast chrome grid (TypeScript)
README
[](https://github.com/copperjs/copper/actions?query=branch%3Amain+event%3Apush) [](https://codecov.io/gh/copperjs/copper) [](https://www.npmjs.com/package/@copperjs/copper)
# Copper
> Copper is a lightweight node.js library which allows creating Chrome or Chromium browser instances for controlling remotely either using [Chrome DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/) or [W3C WebDriver Protocol](https://www.w3.org/TR/webdriver/).
#### Use Cases
- Run tests on a remote chrome browser, using technologies you already use such as [Puppeteer](https://github.com/puppeteer/puppeteer) or [WebdriverIO](https://github.com/webdriverio/webdriverio)
- Run [Selenium](https://www.selenium.dev/documentation/en/introduction/) tests without Selenium - Copper simply replaces the Selenium server and compatible to most selenium clients
- Generate PDF or screenshots of a webpage
- Any other usage of a remote chromium instance you can think of: scraping, crawling, automating, and probably many more - just use Copper to create a remote Chromium and access it using one of the protocols it exposes: [CDP](https://chromedevtools.github.io/devtools-protocol/) and [WebDriver](https://www.w3.org/TR/webdriver/)
### Getting started
##### Installation
```bash
npm i -g @copperjs/copper
# or
yarn global add @copperjs/copper
```
##### Usage
```bash
copper standalone --port 9115
```
run a puppeteer tests using copper:
```js
const puppeteer = require('puppeteer');
(async () => {
const browser = await puppeteer.connect({ browserWSEndpoint: 'ws://localhost:9115' });
const page = await browser.newPage();
await page.goto('https://example.com');
await page.screenshot({ path: 'example.png' });
await browser.close();
})();
```
or run a selenium test using copper:
```js
const webdriverio = require('webdriverio');
(async () => {
const browser = await webdriverio.remote({ path: '/wd/hub/', hostname: 'localhost', port: 9115 });
await browser.url('https://example.com');
await page.saveScreenshot('example.png');
await browser.deleteSession();
})();
```
### Key Features
- Scale out multiple nodes of Copper using a Hub/Node architecture inspired by [Selenium Grid](https://www.selenium.dev/documentation/en/grid/) (Hub/Node).
- Uses pure Node.js - no more complied binaries and jars that must match your browser version. Copper uses [chrome-launcher](https://github.com/GoogleChrome/chrome-launcher/) meaning it will run on any machine with chrome/chromium on it.
- Lightweight and fast - see benchmarks
#### Our Name
As you can see - Copper is right in between Chromium and Selenium in the Periodic table. since what Copper does, is kinda between those two - this name was just there for us to use.
### Roadmap
- [x] create docker files for standalone, headless standalone, node, headless node, hub
- [x] write some uts
- [x] write nice readme
- [x] publish to npm
- [ ] support Docker and publish to Dockerhub
- [ ] support w3c Webdriver commands (WIP)
- [ ] support TLS
- [ ] support HTTP2
- [ ] benchmarks