Skip to content

Latest commit

 

History

History
95 lines (62 loc) · 3.74 KB

README.md

File metadata and controls

95 lines (62 loc) · 3.74 KB
Raw

This project is in maintenance mode

Maintainers or forks welcome: the original James team aren't able to spend the same amount of time on James anymore.

We suggest looking at HTTP Toolkit as an actively maintained open-source alternative.

James

Build Status

James is an HTTP Proxy and Monitor that enables developers to view and intercept requests made from the browser. It is an open-source alternative to the popular developer tool Charles

James is built with hoxy, electron and react

Installing

Download the correct version for your OS and run

All platforms download

Features

Wildcard URL Mappings

To use wildcards in the "url to map" field, put a "*" between two adjacent slashes. For example:

http://foo.com/version/*/app.js -> http://localhost:8000/app.js

Requests which will be redirected:

  • http://foo.com/version/1/app.js
  • http://foo.com/version/26.8/app.js
  • http://foo.com/version/spaghetti/app.js

Requests which will not be redirected:

  • http://foo.com/version/app.js
  • http://bar.com/version/1/app.js

You can also use multiple wildcards in the same URL.

HTTPS Proxying

To enable HTTPS support follow the instructions in our wiki

Contributing

Feel free to open pull requests and issues! If you need inspiration, take a look in the issue section.

Setting up a development environment

The electron instance will automatically reload whenever a change is made

  1. Clone the repository
  2. npm install
  3. npm start

Other useful npm commands

  • npm test: Runs all tests
  • npm run build: Completely builds the app (no watch)
  • npm run lint: Checks all JS code against defined code styling rules
  • npm run release: Creates a standalone app bundle for all operating systems

Guidelines

  • Make sure that no tests are failing
  • Always add tests for new features
  • Make sure that there are no linting errors in your code (use npm run lint)

Communication

We're using Matrix for communication, and you can use the Vector.im client to join the room. (If it doesn't load when you click "join", refresh the page).

Contributors

  • @davidneat
  • @klipstein
  • @mitchhentges
  • @nerdbeere
  • @tomitm

License

The MIT License (MIT)

Copyright (c) 2015 Julian Hollmann

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.