btwedutech/hoppscotch
5
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 6 Wiki Activity

Updated collaborators list

Browse Source
This commit is contained in:
Liyas Thomas
2020-12-21 23:56:35 +05:30
parent 5367a23112
commit a3b7f9a739
2 changed files with 159 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
.all-contributorsrc
View File

@@ -24,24 +24,6 @@
"code" "code"
] ]
}, },
{
"login": "NBTX",
"name": "John Harker",
"avatar_url": "https://avatars3.githubusercontent.com/u/43181178?v=4",
"profile": "https://github.com/NBTX",
"contributions": [
"code"
]
},
{
"login": "jamesgeorge007",
"name": "James George",
"avatar_url": "https://avatars2.githubusercontent.com/u/25279263?v=4",
"profile": "https://ghuser.io/jamesgeorge007",
"contributions": [
"code"
]
}
], ],
"contributorsPerLine": 7, "contributorsPerLine": 7,
"projectName": "hoppscotch", "projectName": "hoppscotch",

193
README.md
View File

@@ -10,7 +10,7 @@
</p> </p>
<p> <p>
[![Website](https://img.shields.io/website?url=https%3A%2F%2Fhoppscotch.io&logo=postwoman)](https://hoppscotch.io) [![Travis Build Status](https://img.shields.io/travis/com/hoppscotch/hoppscotch/main?logo=Travis)](https://travis-ci.com/hoppscotch/hoppscotch) [![GitHub release](https://img.shields.io/github/release/hoppscotch/hoppscotch/all?logo=GitHub)](https://github.com/hoppscotch/hoppscotch/releases/latest) [![Tweet](https://img.shields.io/twitter/url?url=https%3A%2F%2Fhoppscotch.io%2F)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fhoppscotch.io&text=%F0%9F%91%BD%20hoppscotch%20%E2%80%A2%20API%20request%20builder%20-%20Helps%20you%20create%20your%20requests%20faster%2C%20saving%20you%20precious%20time%20on%20your%20development&original_referer=https%3A%2F%2Ftwitter.com%2Fshare%3Ftext%3D%25F0%259F%2591%25BD%2520hoppscotch%2520%25E2%2580%25A2%2520API%2520request%2520builder%2520-%2520Helps%2520you%2520create%2520your%2520requests%2520faster%2C%2520saving%2520you%2520precious%2520time%2520on%2520your%2520development%26url%3Dhttps%3A%2F%2Fhoppscotch.io%26hashtags%3Dhoppscotch%26via%3Dliyasthomas&via=liyasthomas&hashtags=hoppscotch) [![Website](https://img.shields.io/website?url=https%3A%2F%2Fhoppscotch.io&logo=hoppscotch)](https://hoppscotch.io) [![Travis Build Status](https://img.shields.io/travis/com/hoppscotch/hoppscotch/main?logo=Travis)](https://travis-ci.com/hoppscotch/hoppscotch) [![GitHub release](https://img.shields.io/github/release/hoppscotch/hoppscotch/all?logo=GitHub)](https://github.com/hoppscotch/hoppscotch/releases/latest) [![Tweet](https://img.shields.io/twitter/url?url=https%3A%2F%2Fhoppscotch.io%2F)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fhoppscotch.io&text=%F0%9F%91%BD%20hoppscotch%20%E2%80%A2%20API%20request%20builder%20-%20Helps%20you%20create%20your%20requests%20faster%2C%20saving%20you%20precious%20time%20on%20your%20development&original_referer=https%3A%2F%2Ftwitter.com%2Fshare%3Ftext%3D%25F0%259F%2591%25BD%2520hoppscotch%2520%25E2%2580%25A2%2520API%2520request%2520builder%2520-%2520Helps%2520you%2520create%2520your%2520requests%2520faster%2C%2520saving%2520you%2520precious%2520time%2520on%2520your%2520development%26url%3Dhttps%3A%2F%2Fhoppscotch.io%26hashtags%3Dhoppscotch%26via%3Dliyasthomas&via=liyasthomas&hashtags=hoppscotch)
</p> </p>
<p> <p>
@@ -34,7 +34,7 @@
[![Sponsor on GitHub](https://img.shields.io/badge/sponsor-GitHub-181717?logo=github)](https://github.com/sponsors/hoppscotch) [![Contribute on Open Collective](https://img.shields.io/badge/contribute-Open%20Collective-7FADF2?logo=open-collective)](https://opencollective.com/hoppscotch) [![Join on Patreon](https://img.shields.io/badge/join-Patreon-F96854?logo=patreon)](https://www.patreon.com/liyasthomas) [![Donate on PayPal](https://img.shields.io/badge/donate-PayPal-00457C?logo=paypal)](https://www.paypal.me/liyascthomas) [![Sponsor on GitHub](https://img.shields.io/badge/sponsor-GitHub-181717?logo=github)](https://github.com/sponsors/hoppscotch) [![Contribute on Open Collective](https://img.shields.io/badge/contribute-Open%20Collective-7FADF2?logo=open-collective)](https://opencollective.com/hoppscotch) [![Join on Patreon](https://img.shields.io/badge/join-Patreon-F96854?logo=patreon)](https://www.patreon.com/liyasthomas) [![Donate on PayPal](https://img.shields.io/badge/donate-PayPal-00457C?logo=paypal)](https://www.paypal.me/liyascthomas)
<details> <details>
<summary>Table of contents</summary> <summary><i><ins>Table of contents</ins></i></summary>
--- ---
@@ -75,7 +75,10 @@
⚡️ **Fast:** Send requests and get/copy responses in real-time. ⚡️ **Fast:** Send requests and get/copy responses in real-time.
**Methods** <details>
<summary><i><ins>HTTP Methods</ins></i></summary>
---
- `GET` - Requests retrieve resource information - `GET` - Requests retrieve resource information
- `HEAD` - Retrieve response headers identical to those of a GET request, but without the response body. - `HEAD` - Retrieve response headers identical to those of a GET request, but without the response body.
@@ -88,20 +91,34 @@
- `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
- `<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 accent colors. ---
**Theming:** [Customize now ✨](https://hoppscotch.io/settings) </details>
🌈 **Make it yours:** Customizable combinations for background, foreground and accent colors. [Customize now ✨](https://hoppscotch.io/settings)
<details>
<summary><i><ins>Theming</ins></i></summary>
---
- Choose theme: System, Light, Dark (default) and Black - Choose theme: System, Light, Dark (default) and Black
- Choose accent color: Blue, Green (default), Teal, Purple, Orange, Pink, Red, and Yellow - Choose accent color: Blue, Green (default), Teal, Purple, Orange, Pink, Red, and Yellow
- Toggle multi-colored headings - Toggle multi-colored headings
- Toggle auto-scroll to response - Toggle auto-scroll to response
---
</details>
_Customized themes are synced with local session storage_ _Customized themes are synced with local session storage_
🔥 **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.
**Features** <details>
<summary><i><ins>Features</ins></i></summary>
---
- Instant loading with Service Workers - Instant loading with Service Workers
- Offline support - Offline support
@@ -109,23 +126,31 @@ _Customized themes are synced with local session storage_
- Add to Home Screen - Add to Home Screen
- Desktop PWA - Desktop PWA
---
</details>
🚀 **Request:** Retrieve response from endpoint instantly. 🚀 **Request:** Retrieve response from endpoint instantly.
- Choose `method` - Choose `method`
- Enter `URL` - Enter `URL`
- Send - Send
**Features** <details>
<summary><i><ins>Features</ins></i></summary>
---
- Copy/share public "Share URL" - Copy/share public "Share URL"
- Generate/copy request code snippets for 10+ languages and frameworks - Generate/copy request code snippets for 10+ languages and frameworks
- Import `cURL` - Import `cURL`
- Label requests - Label requests
🔌 **WebSocket:** Establish full-duplex communication channels over a single TCP connection. ---
- Send and receive data </details>
- Basic and Bearer Token authentication
🔌 **WebSocket:** Establish full-duplex communication channels over a single TCP connection.
📡 **Server Sent Events:** Receive a stream of updates from a server over a HTTP connection without resorting to polling. 📡 **Server Sent Events:** Receive a stream of updates from a server over a HTTP connection without resorting to polling.
@@ -135,15 +160,27 @@ _Customized themes are synced with local session storage_
🔮 **GraphQL:** GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. 🔮 **GraphQL:** GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data.
<details>
<summary><i><ins>Features</ins></i></summary>
---
- Set endpoint and get schemas - Set endpoint and get schemas
- Multi-column docs - Multi-column docs
- Set custom request headers - Set custom request headers
- Query schema - Query schema
- Get query response - Get query response
---
</details>
🔐 **Authentication:** Allows to identify the end user. 🔐 **Authentication:** Allows to identify the end user.
**Types** <details>
<summary><i><ins>Types</ins></i></summary>
---
- None - None
- Basic - Basic
@@ -151,66 +188,131 @@ _Customized themes are synced with local session storage_
- OAuth 2.0 - OAuth 2.0
- OIDC Access Token/PKCE - OIDC Access Token/PKCE
---
</details>
📢 **Headers:** Describes the format the body of your request is being sent as. 📢 **Headers:** Describes the format the body of your request is being sent as.
📫 **Parameters:** Use request parameters to set varying parts in simulated requests. 📫 **Parameters:** Use request parameters to set varying parts in simulated requests.
📃 **Request Body:** Used to send and receive data via the REST API. 📃 **Request Body:** Used to send and receive data via the REST API.
**Options** <details>
<summary><i><ins>Options</ins></i></summary>
---
- Set `Content Type` - Set `Content Type`
- Add or remove Parameter list - Add or remove Parameter list
- Toggle between key-value and RAW input parameter list - Toggle between key-value and RAW input parameter list
👋 **Responses:** Contains the status line, headers and the message/response body. ---
</details>
👋 **Response:** Contains the status line, headers and the message/response body.
<details>
<summary><i><ins>Features</ins></i></summary>
---
- Copy response to clipboard - Copy response to clipboard
- Download response as a file - Download response as a file
- View preview of HTML responses - View response headers
- View raw and preview of HTML, image, JSON, XML responses
---
</details>
⏰ **History:** Request entries are synced with cloud / local session storage to restore with a single click. ⏰ **History:** Request entries are synced with cloud / local session storage to restore with a single click.
📁 **Collections:** Keep your API requests organized with collections and folders. Reuse them with a single click. 📁 **Collections:** Keep your API requests organized with collections and folders. Reuse them with a single click.
<details>
<summary><i><ins>Features</ins></i></summary>
---
- Unlimited collections, folders and requests
- Nested folders
- Export as / import from GitHub gist
---
</details>
_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.
**Features** <details>
<summary><i><ins>Features</ins></i></summary>
---
- 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://`) - Access APIs served in non-HTTPS (`http://`)
- Use custom Proxy URL - Use custom Proxy URL
---
</details>
_Official Hoppscotch Proxy is hosted by Apollo Software - **[Privacy Policy](https://apollosoftware.xyz/legal/postwoman)**_ _Official Hoppscotch Proxy is hosted by Apollo Software - **[Privacy Policy](https://apollosoftware.xyz/legal/postwoman)**_
📜 **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.
**Use-cases** <details>
<summary><i><ins>Use-cases</ins></i></summary>
---
- Initialize 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
---
</details>
📄 **API Documentation:** Create and share dynamic API documentation easily, quickly. 📄 **API Documentation:** Create and share dynamic API documentation easily, quickly.
**Usage** <details>
<summary><i><ins>Usage</ins></i></summary>
---
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
---
</details>
⌨️ **Keyboard Shortcuts:** Optimized for efficiency. ⌨️ **Keyboard Shortcuts:** Optimized for efficiency.
> **[Shortcuts WIki](https://github.com/hoppscotch/hoppscotch/wiki/Shortcuts)** > **[Shortcuts WIki](https://github.com/hoppscotch/hoppscotch/wiki/Shortcuts)**
🌎 **i18n β:** Experience the app in your own language. 🌎 **i18n β:** Experience the app in your own language.
<details>
<summary><i><ins>Usage</ins></i></summary>
---
1. Scroll down to the footer 1. Scroll down to the footer
2. Click "Choose Language" icon button 2. Click "Choose Language" icon button
3. Select your language from the menu 3. Select your language from the menu
---
</details>
_Keep in mind: Translations aren't available for all source and target language combinations_ _Keep in mind: Translations aren't available for all source and target language combinations_
**To provide a localized experience for users around the world, you can add you own translations.** **To provide a localized experience for users around the world, you can add you own translations.**
@@ -245,24 +347,51 @@ _Add-ons are developed and maintained under **[Official Hoppscotch Organization]
✅ **Post-Request Tests β:** Write tests associated with a request that are executed after the request response. ✅ **Post-Request Tests β:** Write tests associated with a request that are executed after the request response.
**Use-cases** <details>
<summary><i><ins>Use-cases</ins></i></summary>
---
- Check the status code as an integer - Check the status code as an integer
- Filter response headers - Filter response headers
- Parse the response data - Parse the response data
---
</details>
📝 **Notes** : Instantly jot down notes, tasks or whatever you feel like as they come to your mind. 📝 **Notes** : Instantly jot down notes, tasks or whatever you feel like as they come to your mind.
_Notes are only available for signed-in users_ _Notes are only available for signed-in users_
🌱 **Environments** : Environment variables allow you to store and reuse values in your requests and scripts. 🌱 **Environments** : Environment variables allow you to store and reuse values in your requests and scripts.
**Use-cases** <details>
<summary><i><ins>Features</ins></i></summary>
---
- Unlimited environments and variables
- Initialize through pre-request script
- Export as / import from GitHub gist
---
</details>
<details>
<summary><i><ins>Use-cases</ins></i></summary>
---
- 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 likelihood of error - Using variables increases your ability to work efficiently and minimizes the likelihood of error
---
</details>
**To find out more, please check out [Hoppscotch Wiki](https://github.com/hoppscotch/hoppscotch/wiki).** **To find out more, please check out [Hoppscotch Wiki](https://github.com/hoppscotch/hoppscotch/wiki).**
## **Demo** ## **Demo**
@@ -321,7 +450,7 @@ docker run -p 3000:3000 hoppscotch:latest
``` ```
<details> <details>
<summary>Legacy Container</summary> <summary><i><ins>Legacy container</ins></i></summary>
--- ---
@@ -370,9 +499,7 @@ See the [`CHANGELOG`](CHANGELOG.md) file for details.
### Lead Developers ### Lead Developers
- **[Liyas Thomas](https://github.com/liyasthomas)** - _Author_ - **[Liyas Thomas](https://github.com/liyasthomas)** - _Author_
- **[John Harker](https://github.com/NBTX)** - _Lead developer_
- **[Andrew Bastin](https://github.com/andrewbastin)** - _Lead developer_ - **[Andrew Bastin](https://github.com/andrewbastin)** - _Lead developer_
- **[James George](https://github.com/jamesgeorge007)** - _Lead maintainer_
- **[Caneco](https://twitter.com/caneco)** - _Logo and banner designer_ - **[Caneco](https://twitter.com/caneco)** - _Logo and banner designer_
### Testing and Debugging ### Testing and Debugging
@@ -390,8 +517,6 @@ See the [`CHANGELOG`](CHANGELOG.md) file for details.
<tr> <tr>
<td align="center"><a href="https://liyasthomas.web.app"><img src="https://avatars1.githubusercontent.com/u/10395817?v=4" width="100px;" alt=""/><br /><sub><b>Liyas Thomas</b></sub></a><br /><a href="https://github.com/liyasthomas/hoppscotch/commits?author=liyasthomas" title="Code">💻</a> <a href="#design-liyasthomas" title="Design">🎨</a></td> <td align="center"><a href="https://liyasthomas.web.app"><img src="https://avatars1.githubusercontent.com/u/10395817?v=4" width="100px;" alt=""/><br /><sub><b>Liyas Thomas</b></sub></a><br /><a href="https://github.com/liyasthomas/hoppscotch/commits?author=liyasthomas" title="Code">💻</a> <a href="#design-liyasthomas" title="Design">🎨</a></td>
<td align="center"><a href="https://github.com/AndrewBastin"><img src="https://avatars2.githubusercontent.com/u/9131943?v=4" width="100px;" alt=""/><br /><sub><b>Andrew Bastin</b></sub></a><br /><a href="https://github.com/liyasthomas/hoppscotch/commits?author=AndrewBastin" title="Code">💻</a></td> <td align="center"><a href="https://github.com/AndrewBastin"><img src="https://avatars2.githubusercontent.com/u/9131943?v=4" width="100px;" alt=""/><br /><sub><b>Andrew Bastin</b></sub></a><br /><a href="https://github.com/liyasthomas/hoppscotch/commits?author=AndrewBastin" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/NBTX"><img src="https://avatars3.githubusercontent.com/u/43181178?v=4" width="100px;" alt=""/><br /><sub><b>John Harker</b></sub></a><br /><a href="https://github.com/liyasthomas/hoppscotch/commits?author=NBTX" title="Code">💻</a></td>
<td align="center"><a href="https://ghuser.io/jamesgeorge007"><img src="https://avatars2.githubusercontent.com/u/25279263?v=4" width="100px;" alt=""/><br /><sub><b>James George</b></sub></a><br /><a href="https://github.com/liyasthomas/hoppscotch/commits?author=jamesgeorge007" title="Code">💻</a></td>
</tr> </tr>
</table> </table>
@@ -582,7 +707,7 @@ This project is licensed under the [MIT License](https://opensource.org/licenses
<td align="center" width="200px"> <td align="center" width="200px">
<a href="https://hoppscotch.io"> <a href="https://hoppscotch.io">
<br/> <br/>
<img src="https://img.shields.io/badge/Tested_on-Hoppscotch-202124?logo=postwoman"/> <img src="https://img.shields.io/badge/Tested_on-Hoppscotch-202124?logo=hoppscotch"/>
</a> </a>
<br/> <br/>
<sub> <sub>
@@ -590,14 +715,14 @@ This project is licensed under the [MIT License](https://opensource.org/licenses
</sub> </sub>
</td> </td>
<td> <td>
<code>[![hoppscotch](https://img.shields.io/badge/Tested_on-Hoppscotch-202124?logo=postwoman)](https://hoppscotch.io)</code> <code>[![hoppscotch](https://img.shields.io/badge/Tested_on-Hoppscotch-202124?logo=hoppscotch)](https://hoppscotch.io)</code>
</td> </td>
</tr> </tr>
<tr> <tr>
<td align="center" width="200px"> <td align="center" width="200px">
<a href="https://hoppscotch.io"> <a href="https://hoppscotch.io">
<br/> <br/>
<img src="https://img.shields.io/badge/Tested_on-Hoppscotch-success?logo=postwoman"/> <img src="https://img.shields.io/badge/Tested_on-Hoppscotch-success?logo=hoppscotch"/>
</a> </a>
<br/> <br/>
<sub> <sub>
@@ -605,14 +730,14 @@ This project is licensed under the [MIT License](https://opensource.org/licenses
</sub> </sub>
</td> </td>
<td> <td>
<code>[![hoppscotch](https://img.shields.io/badge/Tested_on-Hoppscotch-success?logo=postwoman)](https://hoppscotch.io)</code> <code>[![hoppscotch](https://img.shields.io/badge/Tested_on-Hoppscotch-success?logo=hoppscotch)](https://hoppscotch.io)</code>
</td> </td>
</tr> </tr>
<tr> <tr>
<td align="center" width="200px"> <td align="center" width="200px">
<a href="https://hoppscotch.io"> <a href="https://hoppscotch.io">
<br/> <br/>
<img src="https://img.shields.io/badge/Tested_on-Hoppscotch-critical?logo=postwoman"/> <img src="https://img.shields.io/badge/Tested_on-Hoppscotch-critical?logo=hoppscotch"/>
</a> </a>
<br/> <br/>
<sub> <sub>
@@ -620,14 +745,14 @@ This project is licensed under the [MIT License](https://opensource.org/licenses
</sub> </sub>
</td> </td>
<td> <td>
<code>[![hoppscotch](https://img.shields.io/badge/Tested_on-Hoppscotch-critical?logo=postwoman)](https://hoppscotch.io)</code> <code>[![hoppscotch](https://img.shields.io/badge/Tested_on-Hoppscotch-critical?logo=hoppscotch)](https://hoppscotch.io)</code>
</td> </td>
</tr> </tr>
<tr> <tr>
<td align="center" width="200px"> <td align="center" width="200px">
<a href="https://hoppscotch.io"> <a href="https://hoppscotch.io">
<br/> <br/>
<img src="https://img.shields.io/badge/Tested_on-Hoppscotch-blueviolet?logo=postwoman"/> <img src="https://img.shields.io/badge/Tested_on-Hoppscotch-blueviolet?logo=hoppscotch"/>
</a> </a>
<br/> <br/>
<sub> <sub>
@@ -635,14 +760,14 @@ This project is licensed under the [MIT License](https://opensource.org/licenses
</sub> </sub>
</td> </td>
<td> <td>
<code>[![hoppscotch](https://img.shields.io/badge/Tested_on-Hoppscotch-blueviolet?logo=postwoman)](https://hoppscotch.io)</code> <code>[![hoppscotch](https://img.shields.io/badge/Tested_on-Hoppscotch-blueviolet?logo=hoppscotch)](https://hoppscotch.io)</code>
</td> </td>
</tr> </tr>
<tr> <tr>
<td align="center" width="200px"> <td align="center" width="200px">
<a href="https://hoppscotch.io"> <a href="https://hoppscotch.io">
<br/> <br/>
<img src="https://img.shields.io/badge/your_text-Hoppscotch-hex_color_code?logo=postwoman"/> <img src="https://img.shields.io/badge/your_text-Hoppscotch-hex_color_code?logo=hoppscotch"/>
</a> </a>
<br/> <br/>
<sub> <sub>
@@ -650,7 +775,7 @@ This project is licensed under the [MIT License](https://opensource.org/licenses
</sub> </sub>
</td> </td>
<td> <td>
<code>[![hoppscotch](https://img.shields.io/badge/your_text-Hoppscotch-hex_color_code?logo=postwoman)](https://hoppscotch.io)</code> <code>[![hoppscotch](https://img.shields.io/badge/your_text-Hoppscotch-hex_color_code?logo=hoppscotch)](https://hoppscotch.io)</code>
</td> </td>
</tr> </tr>
</tbody> </tbody>