History

Alexander Prinzhorn 27f990203a web: fix "show more" button (#6958 ) fix #6951		2024-06-25 13:58:26 +02:00
..
gen	Autofix generated JS files and do not patch them in tests (#6910 )	2024-06-12 01:25:46 +02:00
src	web: fix "show more" button (#6958 )	2024-06-25 13:58:26 +02:00
.editorconfig	…
.prettierignore	Add prettier to mitmweb (#5985 )	2023-03-12 17:50:15 +01:00
README.md	Update package-lock.json, bump esbuild (#6915 )	2024-06-12 11:44:25 +00:00
gulpfile.js	web: Upgrade Redux (#6926 )	2024-06-14 00:27:33 +02:00
jest.config.js	Add prettier to mitmweb (#5985 )	2023-03-12 17:50:15 +01:00
package-lock.json	web: Upgrade Redux (#6926 )	2024-06-14 00:27:33 +02:00
package.json	web: Upgrade Redux (#6926 )	2024-06-14 00:27:33 +02:00
tsconfig.json	web: Upgrade Redux (#6926 )	2024-06-14 00:27:33 +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 18 or above. If you are on Ubuntu <= 22.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.

Code formatting

Run npm run prettier to format your code. You can also integrate prettier into your editor, see https://prettier.io/docs/en/editors.html

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.