Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flawiddsouza/Restfox
Offline-First Minimalistic HTTP & Socket Testing Client for the Web & Desktop
https://github.com/flawiddsouza/Restfox
api-client api-testing developer-tools graphql-client hacktoberfest http http-client pwa rest-api rest-client testing-tools vue websocket
Last synced: 2 months ago
JSON representation
Offline-First Minimalistic HTTP & Socket Testing Client for the Web & Desktop
- Host: GitHub
- URL: https://github.com/flawiddsouza/Restfox
- Owner: flawiddsouza
- License: mit
- Created: 2021-11-17T07:00:51.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-22T13:39:50.000Z (3 months ago)
- Last Synced: 2024-10-29T17:14:17.019Z (2 months ago)
- Topics: api-client, api-testing, developer-tools, graphql-client, hacktoberfest, http, http-client, pwa, rest-api, rest-client, testing-tools, vue, websocket
- Language: Vue
- Homepage: https://restfox.dev
- Size: 9.04 MB
- Stars: 2,016
- Watchers: 14
- Forks: 99
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Support: docs/support.md
Awesome Lists containing this project
- awesome-starred - flawiddsouza/Restfox - Offline-first web HTTP client (http)
- awesome-list - flawiddsouza/Restfox - Offline-First Minimalistic HTTP & Socket Testing Client for the Web & Desktop (Vue)
README
# 
# Restfox
[**Web App**](https://restfox.dev) **|** [**Install**](#installation) **|** [**Releases/Downloads**](https://github.com/flawiddsouza/Restfox/releases) **|** [**Screenshots**](#screenshots) **|** [**Docs**](https://docs.restfox.dev) **|** [**Compiling**](#compiling) **|** [**Compiling Web Standalone**](#using-web-standalone)
Offline-First Minimalistic HTTP & Socket Testing Client for the Web & Desktop
Watch video to see plugins in action:
[
](https://www.youtube.com/watch?v=3cOQPm43Wus)
## 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](https://github.com/flawiddsouza/Restfox/releases) page.
### Windows
```
scoop bucket add extras
scoop install restfox
```
There are also precompiled binaries in the [releases](https://github.com/flawiddsouza/Restfox/releases) page.
### [Docker](https://hub.docker.com/r/flawiddsouza/restfox)
```
docker run --name Restfox -d -p 4004:4004 flawiddsouza/restfox:0.29.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.29.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
```bash
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
```bash
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**](#using-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](https://hub.docker.com/r/flawiddsouza/restfox). See: [**Docker**](#docker).