6bb536e0ff
* Add addon to update the ports in alt-svc header to the port that we're listening on * [autofix.ci] apply automated fixes * Add suggested changes * Add tests * [autofix.ci] apply automated fixes * mypy * style * [autofix.ci] apply automated fixes * Add CHANGELOG entry * [autofix.ci] apply automated fixes * nits * [autofix.ci] apply automated fixes * nit: improve option wording --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: Maximilian Hils <git@maximilianhils.com> |
||
---|---|---|
.. | ||
gen | ||
src | ||
.editorconfig | ||
.prettierignore | ||
README.md | ||
eslint.config.mjs | ||
gulpfile.js | ||
jest.config.js | ||
package-lock.json | ||
package.json | ||
tsconfig.json |
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.