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

Merge pull request #937 from liyasthomas/refactor/lint

Browse Source
This commit is contained in:
Liyas Thomas
2020-06-12 13:32:16 +05:30
committed by GitHub
parent b6c16c83c1 bd0208040e
commit 588bdcc2dd
2 changed files with 211 additions and 137 deletions
Download Patch File Download Diff File Expand all files Collapse all files

138
README.md
View File

@@ -23,15 +23,15 @@
--- ---
**Read: _[Story behind Postwoman](https://dev.to/liyasthomas/i-created-postwoman-an-online-open-source-api-request-builder-41md), [Postwoman v1.0](https://dev.to/liyasthomas/postwoman-v1-0-a-free-fast-beautiful-alternative-to-postman-mn0)_** **Read: [Story behind Postwoman](https://dev.to/liyasthomas/i-created-postwoman-an-online-open-source-api-request-builder-41md), [Postwoman v1.0](https://dev.to/liyasthomas/postwoman-v1-0-a-free-fast-beautiful-alternative-to-postman-mn0)**
**Chat: _[Telegram](https://t.me/postwoman_app), [Discord](https://discord.gg/GAMWxmR)_** **Chat: [Telegram](https://t.me/postwoman_app), [Discord](https://discord.gg/GAMWxmR)**
**Donate: _[Open Collective](https://opencollective.com/postwoman), [PayPal](https://www.paypal.me/liyascthomas), [Patreon](https://www.patreon.com/liyasthomas), [:octocat: GitHub Sponsor](https://github.com/sponsors/postwoman-io)_** **Donate: [Open Collective](https://opencollective.com/postwoman), [PayPal](https://www.paypal.me/liyascthomas), [Patreon](https://www.patreon.com/liyasthomas), [:octocat: GitHub Sponsors](https://github.com/sponsors/postwoman-io)**
<div align="center"> <div align="center">
<br> <br>
<img src="static/images/screenshot1.png" alt="Screenshot1" width="100%"> <a href="https://postwoman.io"><img src="static/images/screenshot1.png" alt="Screenshot1" width="100%"></a>
<br> <br>
</div> </div>
@@ -42,6 +42,7 @@
⚡️ **Fast**: Send requests and get/copy responses in real-time - fast software is the best software. ⚡️ **Fast**: Send requests and get/copy responses in real-time - fast software is the best software.
**Methods:** **Methods:**
- `GET` - Retrieve information about the REST API resource - `GET` - Retrieve information about the REST API resource
- `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.
- `POST` - Create a REST API resource - `POST` - Create a REST API resource
@@ -56,6 +57,7 @@
🌈 **Make it yours**: Customizable combinations for background, foreground and accent colors: because customization is freedom. [Customize now ✨](https://postwoman.io/settings). 🌈 **Make it yours**: Customizable combinations for background, foreground and accent colors: because customization is freedom. [Customize now ✨](https://postwoman.io/settings).
**Customizations:** **Customizations:**
- Choose theme: Kinda Dark (default), Clearly White, Just Black and System theme - Choose theme: Kinda Dark (default), Clearly White, Just Black and System theme
- Choose accent color: Green (default), Yellow, Pink, Red, Purple, Orange, Cyan and Blue - Choose accent color: Green (default), Yellow, Pink, Red, Purple, Orange, Cyan and Blue
- Toggle multi-colored headings - Toggle multi-colored headings
@@ -65,6 +67,7 @@ _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:** **Features:**
- Instant loading with [Service Workers](https://developers.google.com/web/fundamentals/primers/service-workers) - Instant loading with [Service Workers](https://developers.google.com/web/fundamentals/primers/service-workers)
- Offline support - Offline support
- Low RAM/memory and CPU usage - Low RAM/memory and CPU usage
@@ -79,6 +82,7 @@ _Customized themes are synced with local session storage_
- Send - Send
**Features:** **Features:**
- Copy/share public "Share URL" - Copy/share public "Share URL"
- Generate request code for `JavaScript XHR`, `Fetch` and `cURL` - Generate request code for `JavaScript XHR`, `Fetch` and `cURL`
- Copy generated request code to clipboard - Copy generated request code to clipboard
@@ -107,6 +111,7 @@ _Customized themes are synced with local session storage_
🔐 **Authentication**: Allows to identify the end user. 🔐 **Authentication**: Allows to identify the end user.
**Types:** **Types:**
- None - None
- Basic - Basic
- Bearer Token - Bearer Token
@@ -122,6 +127,7 @@ _Customized themes are synced with local session storage_
📃 **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:** **Options:**
- 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
@@ -135,6 +141,7 @@ _Customized themes are synced with local session storage_
⏰ **History**: Request entries are synced with local session storage to reuse with a single click. ⏰ **History**: Request entries are synced with local session storage to reuse with a single click.
**Fields:** **Fields:**
- Star - Star
- Label - Label
- Method - Method
@@ -152,6 +159,7 @@ _Histories can be deleted one-by-one or all together_
📁 **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.
**Options:** **Options:**
- Create infinite collections, folders and requests - Create infinite collections, folders and requests
- Edit, delete, move, export, import and replace - Edit, delete, move, export, import and replace
@@ -160,6 +168,7 @@ _Collections are synced with local session storage_
🌐 **Proxy**: Enable Proxy Mode from Settings to access blocked APIs. 🌐 **Proxy**: Enable Proxy Mode from Settings to access blocked APIs.
**Features:** **Features:**
- 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://`)
@@ -170,6 +179,7 @@ _Official Postwoman Proxy is hosted by Apollo Software - **[Privacy Policy](http
📜 **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:** **Use-cases:**
- 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
@@ -178,6 +188,7 @@ _Requests with Pre-Request Scripts are indicated in History entries_
📄 **API Documentation**: Create and share dynamic API documentation easily, quickly. 📄 **API Documentation**: Create and share dynamic API documentation easily, quickly.
**Usage:** **Usage:**
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
@@ -185,7 +196,8 @@ _Requests with Pre-Request Scripts are indicated in History entries_
⌨️ **Keyboard Shortcuts**: Optimized for efficiency. ⌨️ **Keyboard Shortcuts**: Optimized for efficiency.
**Shortcuts:** **Shortcuts:**
- Send Request <kbd>Ctrl</kbd> + <kbd>G</kbd>
- Send/Cancel Request <kbd>Ctrl</kbd> + <kbd>G</kbd>
- Save to Collections <kbd>Ctrl</kbd> + <kbd>S</kbd> - Save to Collections <kbd>Ctrl</kbd> + <kbd>S</kbd>
- Copy Request Link <kbd>Ctrl</kbd> + <kbd>K</kbd> - Copy Request Link <kbd>Ctrl</kbd> + <kbd>K</kbd>
- Reset Request <kbd>Ctrl</kbd> + <kbd>L</kbd> - Reset Request <kbd>Ctrl</kbd> + <kbd>L</kbd>
@@ -204,7 +216,7 @@ _**All `i18n` contributions are welcome to `i18n` [branch](https://github.com/li
📦 **Add-ons**: Official add-ons for Postwoman. 📦 **Add-ons**: Official add-ons for Postwoman.
- **[Proxy β](https://github.com/postwoman-io/postwoman-proxy)** - A simple proxy server created for Postwoman - **[Proxy](https://github.com/postwoman-io/proxywoman)** - A simple proxy server created for Postwoman
- **[CLI β](https://github.com/postwoman-io/postwoman-cli)** - A CLI solution for Postwoman - **[CLI β](https://github.com/postwoman-io/postwoman-cli)** - A CLI solution for Postwoman
- **Browser Extensions** - Browser extensions that simplifies access to Postwoman - **Browser Extensions** - Browser extensions that simplifies access to Postwoman
@@ -217,10 +229,12 @@ _Add-ons are developed and maintained under **[Official Postwoman Organization](
☁️ **Auth + Sync**: Sign in and sync in real-time. ☁️ **Auth + Sync**: Sign in and sync in real-time.
**Sign in with:** **Sign in with:**
- Google - Google
- GitHub - GitHub
**Sync:** **Sync:**
- History - History
- Collections - Collections
- Environments - Environments
@@ -229,6 +243,7 @@ _Add-ons are developed and maintained under **[Official Postwoman 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:** **Use-cases:**
- 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
@@ -240,6 +255,7 @@ _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:** **Use-cases:**
- 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
@@ -265,12 +281,12 @@ You're done!
## Built with 🔧 ## Built with 🔧
* [Chromium](https://github.com/chromium/chromium) - Thanks for being so fast! - [Chromium](https://github.com/chromium/chromium) - Thanks for being so fast!
* HTML - For the web framework - HTML - For the web framework
* CSS - For styling components - CSS - For styling components
* JavaScript - For magic! - JavaScript - For magic!
* [Vue](https://vuejs.org/) - To add to the JavaScript magic! - [Vue](https://vuejs.org/) - To add to the JavaScript magic!
* [Nuxt](https://nuxtjs.org/) - To add to the Vue magic! - [Nuxt](https://nuxtjs.org/) - To add to the Vue magic!
## Developing 👷 ## Developing 👷
@@ -335,18 +351,20 @@ 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* - **[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* - **[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
* ([contributors](https://github.com/liyasthomas/postwoman/graphs/contributors)) - ([contributors](https://github.com/liyasthomas/postwoman/graphs/contributors))
### Collaborators <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> ### Collaborators <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-14-orange.svg?style=flat-square)](#contributors-) [![All Contributors](https://img.shields.io/badge/all_contributors-14-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END --> <!-- ALL-CONTRIBUTORS-BADGE:END -->
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
@@ -375,13 +393,14 @@ See the [CHANGELOG](CHANGELOG.md) file for details.
<!-- markdownlint-enable --> <!-- markdownlint-enable -->
<!-- prettier-ignore-end --> <!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END --> <!-- ALL-CONTRIBUTORS-LIST:END -->
See the list of [contributors](https://github.com/liyasthomas/postwoman/graphs/contributors) who participated in this project. See the list of [contributors](https://github.com/liyasthomas/postwoman/graphs/contributors) who participated in this project.
### Thanks ### Thanks
* [dev.to 👩‍💻👨‍💻](https://dev.to) - [dev.to 👩‍💻👨‍💻](https://dev.to)
### Financial Contributors ### Financial Contributors
@@ -418,9 +437,9 @@ This project is licensed under the [MIT License](https://opensource.org/licenses
## Acknowledgements 🙏 ## Acknowledgements 🙏
* Hat tip to anyone whose code was used - Hat tip to anyone whose code was used
* Inspirations: - Inspirations:
* [Dribbble](https://dribbble.com) - [Dribbble](https://dribbble.com)
## Badges ## Badges
@@ -431,24 +450,79 @@ This project is licensed under the [MIT License](https://opensource.org/licenses
</tr> </tr>
<tbody> <tbody>
<tr> <tr>
<td align="center" width="200px"><a href="https://postwoman.io"><br/><img src="https://img.shields.io/badge/Tested_on-Postwoman-202124?logo=Postwoman"/></a><br/><sub>Default<sub></td> <td align="center" width="200px">
<td><code>[![Postwoman](https://img.shields.io/badge/Tested_on-Postwoman-202124?logo=Postwoman)](https://postwoman.io)</code></td> <a href="https://postwoman.io">
<br/>
<img src="https://img.shields.io/badge/Tested_on-Postwoman-202124?logo=Postwoman"/>
</a>
<br/>
<sub>
Default
</sub>
</td>
<td>
<code>[![Postwoman](https://img.shields.io/badge/Tested_on-Postwoman-202124?logo=Postwoman)](https://postwoman.io)</code>
</td>
</tr> </tr>
<tr> <tr>
<td align="center" width="200px"><a href="https://postwoman.io"><br/><img src="https://img.shields.io/badge/Tested_on-Postwoman-success?logo=Postwoman"/></a><br/><sub>Success<sub></td> <td align="center" width="200px">
<td><code>[![Postwoman](https://img.shields.io/badge/Tested_on-Postwoman-success?logo=Postwoman)](https://postwoman.io)</code></td> <a href="https://postwoman.io">
<br/>
<img src="https://img.shields.io/badge/Tested_on-Postwoman-success?logo=Postwoman"/>
</a>
<br/>
<sub>
Success
</sub>
</td>
<td>
<code>[![Postwoman](https://img.shields.io/badge/Tested_on-Postwoman-success?logo=Postwoman)](https://postwoman.io)</code>
</td>
</tr> </tr>
<tr> <tr>
<td align="center" width="200px"><a href="https://postwoman.io"><br/><img src="https://img.shields.io/badge/Tested_on-Postwoman-critical?logo=Postwoman"/></a><br/><sub>Critical<sub></td> <td align="center" width="200px">
<td><code>[![Postwoman](https://img.shields.io/badge/Tested_on-Postwoman-critical?logo=Postwoman)](https://postwoman.io)</code></td> <a href="https://postwoman.io">
<br/>
<img src="https://img.shields.io/badge/Tested_on-Postwoman-critical?logo=Postwoman"/>
</a>
<br/>
<sub>
Critical
</sub>
</td>
<td>
<code>[![Postwoman](https://img.shields.io/badge/Tested_on-Postwoman-critical?logo=Postwoman)](https://postwoman.io)</code>
</td>
</tr> </tr>
<tr> <tr>
<td align="center" width="200px"><a href="https://postwoman.io"><br/><img src="https://img.shields.io/badge/Tested_on-Postwoman-blueviolet?logo=Postwoman"/></a><br/><sub>Custom<sub></td> <td align="center" width="200px">
<td><code>[![Postwoman](https://img.shields.io/badge/Tested_on-Postwoman-blueviolet?logo=Postwoman)](https://postwoman.io)</code></td> <a href="https://postwoman.io">
<br/>
<img src="https://img.shields.io/badge/Tested_on-Postwoman-blueviolet?logo=Postwoman"/>
</a>
<br/>
<sub>
Custom
</sub>
</td>
<td>
<code>[![Postwoman](https://img.shields.io/badge/Tested_on-Postwoman-blueviolet?logo=Postwoman)](https://postwoman.io)</code>
</td>
</tr> </tr>
<tr> <tr>
<td align="center" width="200px"><a href="https://postwoman.io"><br/><img src="https://img.shields.io/badge/your_text-Postwoman-hex_color_code?logo=Postwoman"/></a><br/><sub>Customize<sub></td> <td align="center" width="200px">
<td><code>[![Postwoman](https://img.shields.io/badge/your_text-Postwoman-hex_color_code?logo=Postwoman)](https://postwoman.io)</code></td> <a href="https://postwoman.io">
<br/>
<img src="https://img.shields.io/badge/your_text-Postwoman-hex_color_code?logo=Postwoman"/>
</a>
<br/>
<sub>
Customize
</sub>
</td>
<td>
<code>[![Postwoman](https://img.shields.io/badge/your_text-Postwoman-hex_color_code?logo=Postwoman)](https://postwoman.io)</code>
</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>

BIN
static/images/screenshot1.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 83 KiB

After

Width:  |  Height:  |  Size: 95 KiB