mirror of
https://github.com/mitmproxy/mitmproxy.git
synced 2024-11-30 16:51:03 +00:00
.. | ||
src | ||
.editorconfig | ||
gulpfile.js | ||
jest.config.js | ||
package-lock.json | ||
package.json | ||
README.md | ||
tsconfig.json |
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:
-
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.