Skip to content

Offline-First Minimalistic HTTP & Socket Testing Client for the Web & Desktop

License

Notifications You must be signed in to change notification settings

flawiddsouza/Restfox

Repository files navigation

Restfox

Restfox

Web App | Install | Releases/Downloads | Screenshots | Docs | Compiling | Compiling Web Standalone

Offline-First Minimalistic HTTP & Socket Testing Client for the Web & Desktop

Watch video to see plugins in action:

Installation

macOS

Package available in homebrew by using:

brew install restfox

Ubuntu and other distributions supporting snap

Package available through snap can be installed using:

sudo snap install restfox

RPM, DEB and NuPKG

There are precompiled binaries in the releases page.

Windows

scoop bucket add extras
scoop install restfox

There are also precompiled binaries in the releases page.

docker run --name Restfox -d -p 4004:4004 flawiddsouza/restfox:0.18.0

Start webapp using docker compose

docker-compose up -d

Start webapp using docker compose with custom port

docker-compose -p 5000:4004 up -d

Start webapp using docker compose with different version

RESTFOX_VERSION=0.18.0 docker-compose up -d

Screenshots

Response History

Context Menu

Environment Variables

Plugins

Compiling

ui

Development

npm run dev

Distribution

npm run build

Desktop distribution and development

npm run build-desktop

Web Standalone distribution and development

npm run build-web-standalone

To upgrade codemirror to latest version

npm i @codemirror/autocomplete@latest @codemirror/commands@latest @codemirror/lang-javascript@latest @codemirror/lang-json@latest @codemirror/language@latest @codemirror/search@latest @codemirror/state@latest @codemirror/view@latest

electron

To upgrade electron to latest version

npm install --save-dev electron@latest @electron-forge/cli@latest @electron-forge/maker-deb@latest @electron-forge/maker-rpm@latest @electron-forge/maker-squirrel@latest @electron-forge/maker-zip@latest @electron-forge/maker-flatpak@latest @electron-forge/publisher-github@latest electron-builder@latest

Development

npm run start

Distribution

npm run make

or

npm run publish

Development

npm run dev

Distribution

npm run build

Using web-standalone

git clone https://github.com/flawiddsouza/Restfox
cd Restfox/packages/ui
npm i
npm run build-web-standalone
cd ../web-standalone
npm i
npm start

By default npm start will run Restfox at port 4004. You can override the port by passing port like so PORT=5040 npm start.

Docker Build Instructions

First refer to Compiling Web Standalone to build successfully locally and use it normally. Then in the project root directory (directory with Dockerfile), execute:

docker build -t restfox:xx .

Note: xx is the version number

After the build is complete, use the following command to start the service:

docker run -d -p:4004:4004 restfox:xx

Visit after successful startup: localhost:4004

Alternatively, you can also use the pre-built Docker image available on Docker Hub. See: Docker.