mirror of https://github.com/vee1e/mitmproxy.git synced 2026-09-02 02:37:15 +00:00

Maximilian Hils 9b119c3dac web: major upgrades

This commit brings a bunch of under-the-hood mitmweb improvements:

 - migrate large parts of the codebase to typescript
 - introduce modern react testing conventions
 - vendor react-codemirror to silence warnings
 - use esbuild for both bundles and tests
 - move from yarn to npm
 - various fixes across the board

2021-06-21 17:51:47 +02:00

1.4 KiB

Raw Permalink Blame History

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 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:

Server: mitmproxy/tools/web
Client: web

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

npm start supports live-reloading if you install a matching browser extension.
You can debug application state using the React DevTools and Redux DevTools browser extensions.

1.4 KiB Raw Permalink Blame History