"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "README.md" between
hoppscotch-2.0.0.tar.gz and hoppscotch-2.1.0.tar.gz

About: Hoppscotch is a light-weight, web based API development suite.

README.md  (hoppscotch-2.0.0):README.md  (hoppscotch-2.1.0)
<div align="center"> <div align="center">
<a href="https://hoppscotch.io"> <a href="https://hoppscotch.io">
<img <img
src="https://raw.githubusercontent.com/hoppscotch/hoppscotch/main/static/l ogo.png" src="https://avatars.githubusercontent.com/u/56705483"
alt="Hoppscotch Logo" alt="Hoppscotch Logo"
height="64" height="64"
/> />
</a> </a>
<br /> <br />
<p> <p>
<h3> <h3>
<b> <b>
Hoppscotch Hoppscotch
</b> </b>
skipping to change at line 39 skipping to change at line 39
Built with โค๏ธŽ by Built with โค๏ธŽ by
<a href="https://github.com/hoppscotch/hoppscotch/graphs/contributors"> <a href="https://github.com/hoppscotch/hoppscotch/graphs/contributors">
contributors contributors
</a> </a>
</sub> </sub>
</p> </p>
<br /> <br />
<p> <p>
<a href="https://hoppscotch.io"> <a href="https://hoppscotch.io">
<img <img
src="https://raw.githubusercontent.com/hoppscotch/hoppscotch/main/static /images/screenshots/light_rest.png" src="https://tiny.cc/hoppscotch_screenshot_1"
alt="Screenshot" alt="Screenshot"
width="100%" width="100%"
/> />
</a> </a>
</p> </p>
</div> </div>
#### **Support** #### **Support**
[![Chat on Discord](https://img.shields.io/badge/chat-Discord-7289DA?logo=discor d)](https://hoppscotch.io/discord) [![Chat on Telegram](https://img.shields.io/b adge/chat-Telegram-2CA5E0?logo=Telegram)](https://hoppscotch.io/telegram) [![Chat on Discord](https://img.shields.io/badge/chat-Discord-7289DA?logo=discor d)](https://hoppscotch.io/discord) [![Chat on Telegram](https://img.shields.io/b adge/chat-Telegram-2CA5E0?logo=Telegram)](https://hoppscotch.io/telegram)
skipping to change at line 92 skipping to change at line 92
- `POST` - The server creates a new entry in a database - `POST` - The server creates a new entry in a database
- `PUT` - Updates an existing resource - `PUT` - Updates an existing resource
- `PATCH` - Very similar to `PUT` but makes a partial update on a resource - `PATCH` - Very similar to `PUT` but makes a partial update on a resource
- `DELETE` - Deletes resource or related component - `DELETE` - Deletes resource or related component
- `HEAD` - Retrieve response headers identical to those of a GET request, but wi thout the response body. - `HEAD` - Retrieve response headers identical to those of a GET request, but wi thout the response body.
- `CONNECT` - Establishes a tunnel to the server identified by the target resour ce - `CONNECT` - Establishes a tunnel to the server identified by the target resour ce
- `OPTIONS` - Describe the communication options for the target resource - `OPTIONS` - Describe the communication options for the target resource
- `TRACE` - Performs a message loop-back test along the path to the target resou rce - `TRACE` - Performs a message loop-back test along the path to the target resou rce
- `<custom>` - Some APIs use custom request methods such as `LIST`. Type in your custom methods. - `<custom>` - Some APIs use custom request methods such as `LIST`. Type in your custom methods.
๐ŸŒˆ **Make it yours:** Customizable combinations for background, foreground and ac cent colors โ€” [customize now โœจ](https://hoppscotch.io/settings). ๐ŸŒˆ **Make it yours:** Customizable combinations for background, foreground and ac cent colors โ€” [customize now](https://hoppscotch.io/settings).
**Theming** **Theming**
- Choose theme: System (default), Light, Dark and Black - Choose theme: System (default), Light, Dark and Black
- Choose accent color: Green (default), Teal, Blue, Indigo, Purple, Yellow, Oran ge, Red and Pink - Choose accent color: Green (default), Teal, Blue, Indigo, Purple, Yellow, Oran ge, Red and Pink
- Distraction free Zen mode - Distraction free Zen mode
_Customized themes are synced with cloud / local session_ _Customized themes are synced with cloud / local session_
๐Ÿ”ฅ **PWA:** Install as a [PWA](https://developers.google.com/web/progressive-web- apps) on your device. ๐Ÿ”ฅ **PWA:** Install as a [PWA](https://developers.google.com/web/progressive-web- apps) on your device.
skipping to change at line 176 skipping to change at line 176
- Unlimited collections, folders and requests - Unlimited collections, folders and requests
- Nested folders - Nested folders
- Export and import as file or GitHub gist - Export and import as file or GitHub gist
_Collections are synced with cloud / local session storage_ _Collections are synced with cloud / local session storage_
๐ŸŒ **Proxy:** Enable Proxy Mode from Settings to access blocked APIs. ๐ŸŒ **Proxy:** Enable Proxy Mode from Settings to access blocked APIs.
- Hide your IP address - Hide your IP address
- Fixes [`CORS`](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) (Cross Origin Resource Sharing) issues - Fixes [`CORS`](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) (Cross Origin Resource Sharing) issues
- Access APIs served in non-HTTPS `[http://]` endpoints - Access APIs served in non-HTTPS (`http://`) endpoints
- Use your own Proxy URL - Use your own Proxy URL
_Official proxy server is hosted by Hoppscotch - **[GitHub](https://github.com/h oppscotch/proxyscotch)** - **[Privacy Policy](https://docs.hoppscotch.io/privacy )**_ _Official proxy server is hosted by Hoppscotch - **[GitHub](https://github.com/h oppscotch/proxyscotch)** - **[Privacy Policy](https://docs.hoppscotch.io/privacy )**_
๐Ÿ“œ **Pre-Request Scripts ฮฒ:** Snippets of code associated with a request that are executed before the request is sent. ๐Ÿ“œ **Pre-Request Scripts ฮฒ:** Snippets of code associated with a request that are executed before the request is sent.
- Set environment variables - Set environment variables
- Include timestamp in the request headers - Include timestamp in the request headers
- Send a random alphanumeric string in the URL parameters - Send a random alphanumeric string in the URL parameters
- Any JavaScript functions - Any JavaScript functions
skipping to change at line 200 skipping to change at line 200
1. Add your requests to Collections and Folders 1. Add your requests to Collections and Folders
2. Export Collections and easily share your APIs with the rest of your team 2. Export Collections and easily share your APIs with the rest of your team
3. Import Collections and Generate Documentation on-the-go 3. Import Collections and Generate Documentation on-the-go
โŒจ๏ธ **Keyboard Shortcuts:** Optimized for efficiency. โŒจ๏ธ **Keyboard Shortcuts:** Optimized for efficiency.
> **[Read our documentation on Keyboard Shortcuts](https://docs.hoppscotch.io/fe atures/shortcuts)** > **[Read our documentation on Keyboard Shortcuts](https://docs.hoppscotch.io/fe atures/shortcuts)**
๐ŸŒŽ **i18n:** Experience the app in your own language. ๐ŸŒŽ **i18n:** Experience the app in your own language.
Help us to translate Hoppscotch. Please read [`TRANSLATIONS`](TRANSLATIONS.md) f
or details on our [`CODE OF CONDUCT`](CODE_OF_CONDUCT.md), and the process for s
ubmitting pull requests to us.
๐Ÿ“ฆ **Add-ons:** Official add-ons for hoppscotch. ๐Ÿ“ฆ **Add-ons:** Official add-ons for hoppscotch.
- **[Proxy](https://github.com/hoppscotch/proxyscotch)** - A simple proxy server created for Hoppscotch - **[Proxy](https://github.com/hoppscotch/proxyscotch)** - A simple proxy server created for Hoppscotch
- **[CLI ฮฒ](https://github.com/hoppscotch/hopp-cli)** - A CLI solution for Hopps cotch - **[CLI ฮฒ](https://github.com/hoppscotch/hopp-cli)** - A CLI solution for Hopps cotch
- **[Browser Extensions](https://github.com/hoppscotch/hoppscotch-extension)** - Browser extensions that simplifies access to Hoppscotch - **[Browser Extensions](https://github.com/hoppscotch/hoppscotch-extension)** - Browser extensions that simplifies access to Hoppscotch
[![Firefox](https://raw.github.com/alrra/browser-logos/master/src/firefox/fire fox_16x16.png) **Firefox**](https://addons.mozilla.org/en-US/firefox/addon/hopps cotch) &nbsp;|&nbsp; [![Chrome](https://raw.github.com/alrra/browser-logos/maste r/src/chrome/chrome_16x16.png) **Chrome**](https://chrome.google.com/webstore/de tail/hoppscotch-extension-for-c/amknoiejhlmhancpahfcfcfhllgkpbld) [![Firefox](https://raw.github.com/alrra/browser-logos/master/src/firefox/fire fox_16x16.png) **Firefox**](https://addons.mozilla.org/en-US/firefox/addon/hopps cotch) &nbsp;|&nbsp; [![Chrome](https://raw.github.com/alrra/browser-logos/maste r/src/chrome/chrome_16x16.png) **Chrome**](https://chrome.google.com/webstore/de tail/hoppscotch-extension-for-c/amknoiejhlmhancpahfcfcfhllgkpbld)
> **Extensions fixes `CORS` issues.** > **Extensions fixes `CORS` issues.**
skipping to change at line 257 skipping to change at line 259
- By storing a value in a variable, you can reference it throughout your request section - By storing a value in a variable, you can reference it throughout your request section
- If you need to update the value, you only have to change it in one place - If you need to update the value, you only have to change it in one place
- Using variables increases your ability to work efficiently and minimizes the l ikelihood of error - Using variables increases your ability to work efficiently and minimizes the l ikelihood of error
--- ---
</details> </details>
๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ฆ **Teams ฮฒ:** Helps you collaborate across your team to design, develop, and test APIs faster. ๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ฆ **Teams ฮฒ:** Helps you collaborate across your team to design, develop, and test APIs faster.
- Unlimited team collections and shared requests - Unlimited teams
- Unlimited shared collections
- Unlimited team members - Unlimited team members
- User roles - Role-based access control
- Cloud sync
- Multiple devices
๐Ÿšš **Bulk Edit:** Edit key-value pairs in bulk.
- Entries are separated by newline
- Keys and values are separated by `:`
- Prepend `//` to any row you want to add but keep disabled
**For more features, please read our [documentation](https://docs.hoppscotch.io) .** **For more features, please read our [documentation](https://docs.hoppscotch.io) .**
## **Demo** ## **Demo**
[hoppscotch.io](https://hoppscotch.io) [hoppscotch.io](https://hoppscotch.io)
## **Usage** ## **Usage**
1. Choose `method` 1. Choose `method`
skipping to change at line 285 skipping to change at line 296
- [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML) - [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML)
- [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS), [SCSS](https://sass-l ang.com), [Windi CSS](https://windicss.org) - [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS), [SCSS](https://sass-l ang.com), [Windi CSS](https://windicss.org)
- [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) - [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
- [TypeScript](https://www.typescriptlang.org) - [TypeScript](https://www.typescriptlang.org)
- [Vue](https://vuejs.org) - [Vue](https://vuejs.org)
- [Nuxt](https://nuxtjs.org) - [Nuxt](https://nuxtjs.org)
## **Developing** ## **Developing**
0. Update [`.env.example`](https://github.com/hoppscotch/hoppscotch/blob/main/.e nv.example) file found in repository's root directory with your own keys and ren ame it to `.env`. 0. Update [`.env.example`](https://github.com/hoppscotch/hoppscotch/blob/main/pa ckages/hoppscotch-app/.env.example) file found in `packages/hoppscotch-app` with your own keys and rename it to `.env`.
_Sample keys only works with the [production build](https://hoppscotch.io)._ _Sample keys only works with the [production build](https://hoppscotch.io)._
### Browser based development environment ### Browser based development environment
- [GitHub codespace](https://docs.github.com/en/codespaces/developing-in-codespa ces/creating-a-codespace) - [GitHub codespace](https://docs.github.com/en/codespaces/developing-in-codespa ces/creating-a-codespace)
- [Gitpod](https://gitpod.io/#https://github.com/hoppscotch/hoppscotch) - [Gitpod](https://gitpod.io/#https://github.com/hoppscotch/hoppscotch)
### Local development environment ### Local development environment
1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) w ith git. 1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) w ith git.
2. Install dependencies by running `npm install` within the directory that you c 2. Install pnpm using npm by running `npm install -g pnpm`.
loned (probably `hoppscotch`). 3. Install dependencies by running `pnpm install` within the directory that you
3. Start the development server with `npm run dev`. cloned (probably `hoppscotch`).
4. Open development site by going to [`http://localhost:3000`](http://localhost: 4. Start the development server with `pnpm run dev`.
3000) in your browser. 5. Open development site by going to [`http://localhost:3000`](http://localhost:
3000) in your browser.
### Docker compose ### Docker compose
1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) w ith git. 1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) w ith git.
2. Run `docker-compose up` 2. Run `docker-compose up`
3. Open development site by going to [`http://localhost:3000`](http://localhost: 3000) in your browser. 3. Open development site by going to [`http://localhost:3000`](http://localhost: 3000) in your browser.
## **Docker** ## **Docker**
**Official container** &nbsp; [![hoppscotch/hoppscotch](https://img.shields.io/d ocker/pulls/hoppscotch/hoppscotch?style=social)](https://hub.docker.com/r/hoppsc otch/hoppscotch) **Official container** &nbsp; [![hoppscotch/hoppscotch](https://img.shields.io/d ocker/pulls/hoppscotch/hoppscotch?style=social)](https://hub.docker.com/r/hoppsc otch/hoppscotch)
```bash ```bash
docker run --rm --name hoppscotch -p 3000:3000 hoppscotch/hoppscotch:latest docker run --rm --name hoppscotch -p 3000:3000 hoppscotch/hoppscotch:latest
``` ```
## **Releasing** ## **Releasing**
1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) w ith git. 1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) w ith git.
2. Install dependencies by running `npm install` within the directory that you c 2. Install pnpm using npm by running `npm install -g pnpm`.
loned (probably `hoppscotch`). 3. Install dependencies by running `pnpm install` within the directory that you
3. Build the release files with `npm run generate`. cloned (probably `hoppscotch`).
4. Find the built project in `./dist`. 4. Build the release files with `pnpm run generate`.
5. Find the built project in `packages/hoppscotch-app/dist`.
## **Contributing** ## **Contributing**
Please contribute using [GitHub Flow](https://guides.github.com/introduction/flo w). Create a branch, add commits, and [open a pull request](https://github.com/h oppscotch/hoppscotch/compare). Please contribute using [GitHub Flow](https://guides.github.com/introduction/flo w). Create a branch, add commits, and [open a pull request](https://github.com/h oppscotch/hoppscotch/compare).
Please read [`CONTRIBUTING`](CONTRIBUTING.md) for details on our [`CODE OF CONDU CT`](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us. Please read [`CONTRIBUTING`](CONTRIBUTING.md) for details on our [`CODE OF CONDU CT`](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us.
## **Continuous Integration** ## **Continuous Integration**
We use [GitHub Actions](https://github.com/features/actions) for continuous inte gration. Check out our [build workflows](https://github.com/hoppscotch/hoppscotc h/actions). We use [GitHub Actions](https://github.com/features/actions) for continuous inte gration. Check out our [build workflows](https://github.com/hoppscotch/hoppscotc h/actions).
 End of changes. 10 change blocks. 
16 lines changed or deleted 31 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)