mirror of
https://github.com/mitmproxy/mitmproxy.git
synced 2024-11-23 05:09:57 +00:00
e1ea491ad7
Some checks failed
autofix.ci / autofix (push) Failing after 1s
CI / lint (push) Failing after 1s
CI / filename-matching (push) Failing after 0s
CI / mypy (push) Failing after 0s
CI / individual-coverage (push) Failing after 0s
CI / test (ubuntu-latest, 3.10) (push) Failing after 0s
CI / test (ubuntu-latest, 3.11) (push) Failing after 0s
CI / test (ubuntu-latest, 3.12) (push) Failing after 0s
CI / test (ubuntu-latest, 3.13-dev) (push) Failing after 0s
CI / test-old-dependencies (push) Failing after 0s
CI / build (ubuntu-20.04, linux) (push) Failing after 0s
CI / build-wheel (push) Failing after 0s
CI / test-docker (push) Has been skipped
CI / test-web-ui (push) Failing after 0s
CI / docs (push) Failing after 0s
CI / test (macos-latest, 3.13-dev) (push) Has been cancelled
CI / test (windows-latest, 3.13-dev) (push) Has been cancelled
CI / build (macos-12, macos-x86_64) (push) Has been cancelled
CI / build (macos-14, macos-arm64) (push) Has been cancelled
CI / build (windows-2019, windows) (push) Has been cancelled
CI / build-windows-installer (push) Has been cancelled
CI / check (push) Has been cancelled
CI / deploy-docker (push) Has been cancelled
CI / deploy (push) Has been cancelled
* add script to generate all possible web columns * remove test for now * Make web_columns.py executable * [autofix.ci] apply automated fixes * add back tests * [autofix.ci] apply automated fixes * update changelog * update changelog and add coauthor Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: Abhishek-Bohora <abhishek.bohora16@gmail.com> |
||
---|---|---|
.. | ||
gen | ||
src | ||
.editorconfig | ||
.prettierignore | ||
eslint.config.mjs | ||
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 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.