mitmproxy/web
Maximilian Hils d003038803 fix nits 2022-06-28 15:53:49 +02:00
..
src fix nits 2022-06-28 15:53:49 +02:00
.editorconfig [web] editor config for line endings 2016-06-17 06:26:46 +08:00
README.md Clarify web frontend docs (#5055) 2022-01-14 13:00:47 +01:00
gulpfile.js Merge pull request #4779 from mhils/mitmweb-tcp 2021-08-25 13:35:37 +02:00
jest.config.js web: test coverage++, adjust commandbar 2021-08-20 18:38:22 +02:00
package-lock.json web: update dependencies 2021-08-20 18:47:34 +02:00
package.json web: update dependencies 2021-08-20 18:47:34 +02:00
tsconfig.json major mitmweb upgrades 2021-08-18 17:38:22 +02:00

README.md

Quick Start

  • Install mitmproxy as described in ../CONTRIBUTING.md
  • Run node --version to make sure that you have at least Node.js 14 or above. If you are on Ubuntu <= 20.04, you need to upgrade.
  • Run cd mitmproxy/web to change to the directory with package.json
  • Run npm install to install dependencies
  • Run npm start to start live-compilation
  • Run mitmweb after activating your Python virtualenv (see ../CONTRIBUTING.md).

Testing

  • Run npm test to run the test suite.

Architecture

There are two components:

Contributing

We very much appreciate any (small) improvements to mitmweb. Please do not include the compiled assets in mitmproxy/tools/web/static in your pull request. Refreshing them on every commit would massively increase repository size. We will update these files before every release.

Developer Tools