Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/christian-bromann/devtools-backend
Standalone implementation of the Chrome DevTools backend to debug arbitrary web environments.
https://github.com/christian-bromann/devtools-backend
Last synced: 8 days ago
JSON representation
Standalone implementation of the Chrome DevTools backend to debug arbitrary web environments.
- Host: GitHub
- URL: https://github.com/christian-bromann/devtools-backend
- Owner: christian-bromann
- License: apache-2.0
- Created: 2017-05-02T08:39:42.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-02-01T18:50:59.000Z (almost 3 years ago)
- Last Synced: 2024-10-24T08:40:57.585Z (15 days ago)
- Language: JavaScript
- Homepage:
- Size: 1.96 MB
- Stars: 143
- Watchers: 10
- Forks: 23
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-star - devtools-backend - bromann | 139 | (JavaScript)
- awesome-chrome-devtools - DevTools Backend - Standalone implementation of the Chrome DevTools backend to debug arbitrary web environments. (Alumni / Automation)
README
DevTools Backend
================
‼️ __Attention:__ this project is not maintained anymore. Dependencies are out of date and introduce security vulnerabilities. Please not use it in production. ‼️
A Node.JS implementation of the Chrome DevTools backend for debugging arbitrary web platforms (e.g. HbbTV applications on Smart TVs). It is the counterpart of the [devtools-frontend](https://github.com/ChromeDevTools/devtools-frontend) and is like [weinre](https://people.apache.org/~pmuellr/weinre/docs/latest/Home.html) just in "new".
# Requirements
- [Node.js](https://nodejs.org/en/) (v8.2.1)
- [NPM](https://www.npmjs.com/) (v5.3.0 or higher)
# Installation
To run the server you need to first clone the repo and install all its dependencies:
```sh
# clone repository
$ git clone [email protected]:christian.bromann/devtools-backend.git
$ cd devtools-backend
# install dependencies
$ npm install
# build project
$ npm run build
```
Then start the server by executing:
```sh
$ npm run start
```
You now have started the server on `localhost:9222`. You can see a list of inspectable pages on http://localhost:9222 (also available as [json](http://localhost:9222/json)).
# Instrument Your Web Application
The DevTools Backend allows you to instrument your app in two different ways. You can either inject a script manually into your app or use the proxy to automate the injection.
## Manual Script Injection
To manually inject a script put the following script tag at the top of your page:
```html
```
Once you open a page with a web client (like a browser) it should register your page and it should then be inspectable.
## Proxy Script Injection
If your web client supports proxy settings you can also use the DevTools backend as HTTP proxy (note that this only works for pages served via http on port 80). Per default the server starts with the hostname of the machine it runs on. For example if you run the project on localhost and setup Firefox to proxy request to `localhost:9222` it would allow to debug the Firefox browser with the DevTools application.
## Logging
For debugging purposes you can set a logging path as environment variable and the DevTools Proxy will dump all log messages to multiple files within this directory. To set a logging directory just export `LOGGING_PATH`:
```sh
export LOGGING_PATH=/home/user/logs
# or start the server with that environment variable set
LOGGING_PATH=/home/user/logs npm run start
```
## Development
To recompile files automatically run:
```sh
$ npm run dev
```
After files are recompiled you need to restart the server. This can be triggered automatically when running it in "dev" mode:
```sh
$ npm run start:dev
```
***
This project was created as part of a master thesis by [Christian Bromann](https://github.com/christian-bromann) on _"Design and implementation of a Development and Test Automation Platform for HbbTV"_. The dissertation originated in cooperation with the [Fraunhofer Institute for Open Communication Systems (FOKUS)](https://www.fokus.fraunhofer.de/en) and [Louay Bassbouss](https://github.com/louaybassbouss).