Update README.md
This commit is contained in:
205
README.md
205
README.md
@@ -1,16 +1,16 @@
|
|||||||
<div align="center">
|
<div align="center">
|
||||||
<a href="https://hoppscotch.io"><img src="https://raw.githubusercontent.com/hoppscotch/hoppscotch/master/static/logo.png" alt="hoppscotch.io logo" height="160"></a>
|
<a href="https://hoppscotch.io"><img src="https://raw.githubusercontent.com/hoppscotch/hoppscotch/master/static/logo.png" alt="hoppscotch.io logo" height="128"></a>
|
||||||
<br>
|
<br>
|
||||||
<br>
|
<br>
|
||||||
<p>
|
<p>
|
||||||
<b>A free, fast and beautiful API request builder</b>
|
<b>Hoppscotch - A free, fast and beautiful API request builder</b>
|
||||||
</p>
|
</p>
|
||||||
<p>
|
<p>
|
||||||
<i>Helps you create requests faster, saving precious time on development - <a href="https://hoppscotch.launchaco.com">Subscribe</a></i>
|
<i>Helps you create requests faster, saving precious time on development - <a href="https://hoppscotch.launchaco.com">Subscribe</a></i>
|
||||||
</p>
|
</p>
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
[](https://travis-ci.com/hoppscotch/hoppscotch) [](https://github.com/hoppscotch/hoppscotch/releases/latest) [](https://hoppscotch.io) [](CONTRIBUTING.md) [](https://opencollective.com/hoppscotch) [](https://www.paypal.me/liyascthomas) [](https://t.me/hoppscotch) [](https://discord.gg/GAMWxmR) [](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)
|
[](https://hoppscotch.io) [](https://travis-ci.com/hoppscotch/hoppscotch) [](https://github.com/hoppscotch/hoppscotch/releases/latest) [](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>
|
||||||
@@ -21,59 +21,62 @@
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Chat: [Telegram](https://t.me/hoppscotch), [Discord](https://discord.gg/GAMWxmR)**
|
|
||||||
|
|
||||||
**Donate: [GitHub Sponsors](https://github.com/sponsors/hoppscotch), [Open Collective](https://opencollective.com/hoppscotch), [Patreon](https://www.patreon.com/liyasthomas), [PayPal](https://www.paypal.me/liyascthomas)**
|
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<a href="https://hoppscotch.io"><img src="https://raw.githubusercontent.com/hoppscotch/hoppscotch/master/static/images/screenshot1.png" alt="Screenshot1" width="100%"></a>
|
<a href="https://hoppscotch.io"><img src="https://raw.githubusercontent.com/hoppscotch/hoppscotch/master/static/images/screenshot1.png" alt="Screenshot1" width="100%"></a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
#### **Contact**
|
||||||
|
|
||||||
|
[](https://t.me/hoppscotch) [](https://discord.gg/GAMWxmR)
|
||||||
|
|
||||||
|
#### **Support**
|
||||||
|
|
||||||
|
[](https://github.com/sponsors/hoppscotch) [](https://opencollective.com/hoppscotch) [](https://www.patreon.com/liyasthomas) [](https://www.paypal.me/liyascthomas)
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>Table of contents</summary>
|
<summary>Table of contents</summary>
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
- [Features](#features-)
|
- [Features](#features)
|
||||||
- [Demo](#demo--)
|
- [Demo](#demo)
|
||||||
- [Usage](#usage-)
|
- [Usage](#usage)
|
||||||
- [Built with](#built-with-)
|
- [Built with](#built-with)
|
||||||
- [Developing](#developing-)
|
- [Developing](#developing)
|
||||||
- [Browser based development environment](#browser-based-development-environment)
|
- [Browser based development environment](#browser-based-development-environment)
|
||||||
- [Local development environment](#local-development-environment)
|
- [Local development environment](#local-development-environment)
|
||||||
- [Docker compose](#docker-compose)
|
- [Docker compose](#docker-compose)
|
||||||
- [Docker](#docker--)
|
- [Docker](#docker)
|
||||||
- [Releasing](#releasing-)
|
- [Releasing](#releasing)
|
||||||
- [Contributing](#contributing-)
|
- [Contributing](#contributing)
|
||||||
- [Continuous Integration](#continuous-integration--)
|
- [Continuous Integration](#continuous-integration)
|
||||||
- [Versioning](#versioning--)
|
- [Versioning](#versioning)
|
||||||
- [Change log](#change-log-)
|
- [Changelog](#changelog)
|
||||||
- [Authors](#authors-)
|
- [Authors](#authors)
|
||||||
- [Lead Developers](#lead-developers)
|
- [Lead Developers](#lead-developers)
|
||||||
- [Testing and Debugging](#testing-and-debugging)
|
- [Testing and Debugging](#testing-and-debugging)
|
||||||
- [Collaborators](#collaborators-)
|
- [Collaborators](#collaborators-)
|
||||||
- [Thanks](#thanks)
|
- [Thanks](#thanks)
|
||||||
- [Financial Contributors](#financial-contributors)
|
- [Financial Contributors](#financial-contributors)
|
||||||
|
- [GitHub Sponsors](#github-sponsors)
|
||||||
- [Organizations](#organizations)
|
- [Organizations](#organizations)
|
||||||
- [Individuals](#individuals)
|
- [Individuals](#individuals)
|
||||||
- [Code Contributors](#code-contributors)
|
- [Code Contributors](#code-contributors)
|
||||||
- [License](#license-)
|
- [License](#license)
|
||||||
- [Acknowledgements](#acknowledgements-)
|
- [Acknowledgements](#acknowledgements)
|
||||||
- [Badges](#badges-)
|
- [Badges](#badges)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
### Features ✨
|
### **Features**
|
||||||
|
|
||||||
❤️ **Lightweight**: Crafted with minimalistic UI design.
|
❤️ **Lightweight:** Crafted with minimalistic UI design.
|
||||||
|
|
||||||
⚡️ **Fast**: Send requests and get/copy responses in real-time.
|
⚡️ **Fast:** Send requests and get/copy responses in real-time.
|
||||||
|
|
||||||
**Methods:**
|
**Methods**
|
||||||
|
|
||||||
- `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.
|
||||||
@@ -86,7 +89,7 @@
|
|||||||
- `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.
|
🌈 **Make it yours:** Customizable combinations for background, foreground and accent colors.
|
||||||
|
|
||||||
**Theming:** [Customize now ✨](https://hoppscotch.io/settings)
|
**Theming:** [Customize now ✨](https://hoppscotch.io/settings)
|
||||||
|
|
||||||
@@ -97,9 +100,9 @@
|
|||||||
|
|
||||||
_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:**
|
**Features**
|
||||||
|
|
||||||
- Instant loading with Service Workers
|
- Instant loading with Service Workers
|
||||||
- Offline support
|
- Offline support
|
||||||
@@ -107,31 +110,31 @@ _Customized themes are synced with local session storage_
|
|||||||
- Add to Home Screen
|
- Add to Home Screen
|
||||||
- Desktop PWA
|
- Desktop PWA
|
||||||
|
|
||||||
🚀 **Request**: Retrieve response from endpoint instantly.
|
🚀 **Request:** Retrieve response from endpoint instantly.
|
||||||
|
|
||||||
- Choose `method`
|
- Choose `method`
|
||||||
- Enter `URL`
|
- Enter `URL`
|
||||||
- Send
|
- Send
|
||||||
|
|
||||||
**Features:**
|
**Features**
|
||||||
|
|
||||||
- Copy/share public "Share URL"
|
- Copy/share public "Share URL"
|
||||||
- Generate/copy request code for `JavaScript XHR`, `Fetch` and `cURL`
|
- Generate/copy request code for `JavaScript XHR`, `Fetch` and `cURL`
|
||||||
- Import `cURL`
|
- Import `cURL`
|
||||||
- Label requests
|
- Label requests
|
||||||
|
|
||||||
🔌 **WebSocket**: Establish full-duplex communication channels over a single TCP connection.
|
🔌 **WebSocket:** Establish full-duplex communication channels over a single TCP connection.
|
||||||
|
|
||||||
- Send and receive data
|
- Send and receive data
|
||||||
- Basic and Bearer Token authentication
|
- Basic and Bearer Token authentication
|
||||||
|
|
||||||
📡 **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.
|
||||||
|
|
||||||
🌩 **Socket.IO**: Send and Receive data with SocketIO server.
|
🌩 **Socket.IO:** Send and Receive data with SocketIO server.
|
||||||
|
|
||||||
🦟 **MQTT**: Subscribe and Publish to topics of a MQTT Broker.
|
🦟 **MQTT:** Subscribe and Publish to topics of a MQTT Broker.
|
||||||
|
|
||||||
🔮 **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.
|
||||||
|
|
||||||
- Set endpoint and get schemas
|
- Set endpoint and get schemas
|
||||||
- Multi-column docs
|
- Multi-column docs
|
||||||
@@ -139,9 +142,9 @@ _Customized themes are synced with local session storage_
|
|||||||
- Query schema
|
- Query schema
|
||||||
- Get query response
|
- Get query response
|
||||||
|
|
||||||
🔐 **Authentication**: Allows to identify the end user.
|
🔐 **Authentication:** Allows to identify the end user.
|
||||||
|
|
||||||
**Types:**
|
**Types**
|
||||||
|
|
||||||
- None
|
- None
|
||||||
- Basic
|
- Basic
|
||||||
@@ -149,33 +152,33 @@ _Customized themes are synced with local session storage_
|
|||||||
- OAuth 2.0
|
- OAuth 2.0
|
||||||
- OIDC Access Token/PKCE
|
- OIDC Access Token/PKCE
|
||||||
|
|
||||||
📢 **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:**
|
**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
|
||||||
|
|
||||||
👋 **Responses**: Contains the status line, headers and the message/response body.
|
👋 **Responses:** Contains the status line, headers and the message/response body.
|
||||||
|
|
||||||
- Copy response to clipboard
|
- Copy response to clipboard
|
||||||
- Download response as a file
|
- Download response as a file
|
||||||
- View preview of HTML responses
|
- View preview of HTML responses
|
||||||
|
|
||||||
⏰ **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.
|
||||||
|
|
||||||
_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:**
|
**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
|
||||||
@@ -184,26 +187,26 @@ _Collections are synced with cloud / local session storage_
|
|||||||
|
|
||||||
_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:**
|
**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
|
||||||
|
|
||||||
📄 **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
|
||||||
|
|
||||||
⌨️ **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.
|
||||||
|
|
||||||
1. Scroll down to the footer
|
1. Scroll down to the footer
|
||||||
2. Click "Choose Language" icon button
|
2. Click "Choose Language" icon button
|
||||||
@@ -215,7 +218,7 @@ _Keep in mind: Translations aren't available for all source and target language
|
|||||||
|
|
||||||
_**All `i18n` contributions are welcome to `i18n` [branch](https://github.com/hoppscotch/hoppscotch/tree/i18n) only!**_
|
_**All `i18n` contributions are welcome to `i18n` [branch](https://github.com/hoppscotch/hoppscotch/tree/i18n) only!**_
|
||||||
|
|
||||||
📦 **Add-ons**: Official add-ons for hoppscotch.
|
📦 **Add-ons:** Official add-ons for hoppscotch.
|
||||||
|
|
||||||
- **[Proxy](https://github.com/hoppscotch/proxywoman)** - A simple proxy server created for Hoppscotch
|
- **[Proxy](https://github.com/hoppscotch/proxywoman)** - A simple proxy server created for Hoppscotch
|
||||||
- **[CLI β](https://github.com/hoppscotch/hopp-cli)** - A CLI solution for Hoppscotch
|
- **[CLI β](https://github.com/hoppscotch/hopp-cli)** - A CLI solution for Hoppscotch
|
||||||
@@ -227,23 +230,23 @@ _**All `i18n` contributions are welcome to `i18n` [branch](https://github.com/ho
|
|||||||
|
|
||||||
_Add-ons are developed and maintained under **[Official Hoppscotch Organization](https://github.com/hoppscotch)**._
|
_Add-ons are developed and maintained under **[Official Hoppscotch Organization](https://github.com/hoppscotch)**._
|
||||||
|
|
||||||
☁️ **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
|
||||||
- Notes
|
- Notes
|
||||||
|
|
||||||
✅ **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
|
||||||
@@ -255,7 +258,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
|
||||||
@@ -263,26 +266,26 @@ _Notes are only available for signed-in users_
|
|||||||
|
|
||||||
**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 🚀 [](https://hoppscotch.io)
|
## **Demo**
|
||||||
|
|
||||||
[hoppscotch.io](https://hoppscotch.io)
|
[hoppscotch.io](https://hoppscotch.io)
|
||||||
|
|
||||||
## Usage 💡
|
## **Usage**
|
||||||
|
|
||||||
1. Choose `method`
|
1. Choose `method`
|
||||||
2. Enter `URL`
|
2. Enter `URL`
|
||||||
3. Send request
|
3. Send request
|
||||||
4. Get response
|
4. Get response
|
||||||
|
|
||||||
## Built with 🔧
|
## **Built with**
|
||||||
|
|
||||||
- HTML - For the web framework
|
- [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML)
|
||||||
- CSS - For styling components
|
- [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS), [SCSS](https://sass-lang.com), [Tailwind CSS](https://tailwindcss.com)
|
||||||
- JavaScript - For magic!
|
- [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
|
||||||
- [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/master/.env.example) file found in repository's root directory with your own keys and rename it to `.env`.
|
0. Update [`.env.example`](https://github.com/hoppscotch/hoppscotch/blob/master/.env.example) file found in repository's root directory with your own keys and rename it to `.env`.
|
||||||
|
|
||||||
@@ -305,7 +308,7 @@ _Sample keys only works with the [production build](https://hoppscotch.io)._
|
|||||||
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 🐳 [](https://hub.docker.com/r/liyasthomas/postwoman)
|
## **Docker**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
#pull
|
#pull
|
||||||
@@ -318,32 +321,32 @@ docker build -t postwoman:latest .
|
|||||||
docker run -p 3000:3000 postwoman:latest
|
docker run -p 3000:3000 postwoman:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
## Releasing 🧞
|
## **Releasing**
|
||||||
|
|
||||||
1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) with git.
|
1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) with git.
|
||||||
2. Install dependencies by running `npm install` within the directory that you cloned (probably `hoppscotch`).
|
2. Install dependencies by running `npm install` within the directory that you cloned (probably `hoppscotch`).
|
||||||
3. Build the release files with `npm run build`.
|
3. Build the release files with `npm run build`.
|
||||||
4. Find the built project in `./dist`.
|
4. Find the built project in `./dist`.
|
||||||
|
|
||||||
## Contributing 🍰
|
## **Contributing**
|
||||||
|
|
||||||
Please contribute using [GitHub Flow](https://guides.github.com/introduction/flow). Create a branch, add commits, and [open a pull request](https://github.com/hoppscotch/hoppscotch/compare).
|
Please contribute using [GitHub Flow](https://guides.github.com/introduction/flow). Create a branch, add commits, and [open a pull request](https://github.com/hoppscotch/hoppscotch/compare).
|
||||||
|
|
||||||
Please read [`CONTRIBUTING`](CONTRIBUTING.md) for details on our [`CODE OF CONDUCT`](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us.
|
Please read [`CONTRIBUTING`](CONTRIBUTING.md) for details on our [`CODE OF CONDUCT`](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us.
|
||||||
|
|
||||||
## Continuous Integration 💚 [](https://travis-ci.com/hoppscotch/hoppscotch)
|
## **Continuous Integration**
|
||||||
|
|
||||||
We use [Travis CI](https://travis-ci.com) for continuous integration. Check out our [Travis CI Status](https://travis-ci.com/hoppscotch/hoppscotch).
|
We use [Travis CI](https://travis-ci.com) for continuous integration. Check out our [Travis CI Status](https://travis-ci.com/hoppscotch/hoppscotch).
|
||||||
|
|
||||||
## Versioning 🔖 [](https://github.com/hoppscotch/hoppscotch/releases/latest)
|
## **Versioning**
|
||||||
|
|
||||||
This project is developed by [Liyas Thomas](https://github.com/liyasthomas) using the [Semantic Versioning specification](https://semver.org). For the versions available, see the [releases on this repository](https://github.com/liyasthomas/hoppscotch/releases).
|
This project is developed by [Liyas Thomas](https://github.com/liyasthomas) using the [Semantic Versioning specification](https://semver.org). For the versions available, see the [releases on this repository](https://github.com/liyasthomas/hoppscotch/releases).
|
||||||
|
|
||||||
## Change log 📝
|
## **Changelog**
|
||||||
|
|
||||||
See the [`CHANGELOG`](CHANGELOG.md) file for details.
|
See the [`CHANGELOG`](CHANGELOG.md) file for details.
|
||||||
|
|
||||||
## Authors 🧙
|
## **Authors**
|
||||||
|
|
||||||
### Lead Developers
|
### Lead Developers
|
||||||
|
|
||||||
@@ -400,133 +403,133 @@ See the list of [contributors](https://github.com/hoppscotch/hoppscotch/graphs/c
|
|||||||
|
|
||||||
### Financial Contributors
|
### Financial Contributors
|
||||||
|
|
||||||
Become a financial contributor and help us sustain our community [[Contribute](https://opencollective.com/hoppscotch/contribute)].
|
Become a financial contributor and help us sustain our community [[Support](#support)].
|
||||||
|
|
||||||
#### GitHub Sponsors
|
#### GitHub Sponsors
|
||||||
|
|
||||||
<a href="https://github.com/scmmishra" target="_blank" rel="noopener">
|
<a href="https://github.com/scmmishra" target="_blank" rel="noopener">
|
||||||
<img
|
<img
|
||||||
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
||||||
src="https://github.com/scmmishra.png?size=128"
|
src="https://github.com/scmmishra.png?size=64"
|
||||||
alt="Shivam Mishra"
|
alt="Shivam Mishra"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="https://zach.codes" target="_blank" rel="noopener">
|
<a href="https://zach.codes" target="_blank" rel="noopener">
|
||||||
<img
|
<img
|
||||||
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
||||||
src="https://github.com/zackify.png?size=128"
|
src="https://github.com/zackify.png?size=64"
|
||||||
alt="Zach Silveira"
|
alt="Zach Silveira"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/pantharshit00" target="_blank" rel="noopener">
|
<a href="https://github.com/pantharshit00" target="_blank" rel="noopener">
|
||||||
<img
|
<img
|
||||||
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
||||||
src="https://github.com/pantharshit00.png?size=128"
|
src="https://github.com/pantharshit00.png?size=64"
|
||||||
alt="Harshit Pant"
|
alt="Harshit Pant"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/janpio" target="_blank" rel="noopener">
|
<a href="https://github.com/janpio" target="_blank" rel="noopener">
|
||||||
<img
|
<img
|
||||||
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
||||||
src="https://github.com/janpio.png?size=128"
|
src="https://github.com/janpio.png?size=64"
|
||||||
alt="Jan Piotrowski"
|
alt="Jan Piotrowski"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/ankumar" target="_blank" rel="noopener">
|
<a href="https://github.com/ankumar" target="_blank" rel="noopener">
|
||||||
<img
|
<img
|
||||||
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
||||||
src="https://github.com/ankumar.png?size=128"
|
src="https://github.com/ankumar.png?size=64"
|
||||||
alt="Anil Kumar"
|
alt="Anil Kumar"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/gpeal" target="_blank" rel="noopener">
|
<a href="https://github.com/gpeal" target="_blank" rel="noopener">
|
||||||
<img
|
<img
|
||||||
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
||||||
src="https://github.com/gpeal.png?size=128"
|
src="https://github.com/gpeal.png?size=64"
|
||||||
alt="Gabriel Peal"
|
alt="Gabriel Peal"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/koddsson" target="_blank" rel="noopener">
|
<a href="https://github.com/koddsson" target="_blank" rel="noopener">
|
||||||
<img
|
<img
|
||||||
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
||||||
src="https://github.com/koddsson.png?size=128"
|
src="https://github.com/koddsson.png?size=64"
|
||||||
alt="Kristján Oddsson"
|
alt="Kristján Oddsson"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/donokuda" target="_blank" rel="noopener">
|
<a href="https://github.com/donokuda" target="_blank" rel="noopener">
|
||||||
<img
|
<img
|
||||||
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
||||||
src="https://github.com/donokuda.png?size=128"
|
src="https://github.com/donokuda.png?size=64"
|
||||||
alt="Don Okuda"
|
alt="Don Okuda"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/ebrescia" target="_blank" rel="noopener">
|
<a href="https://github.com/ebrescia" target="_blank" rel="noopener">
|
||||||
<img
|
<img
|
||||||
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
||||||
src="https://github.com/ebrescia.png?size=128"
|
src="https://github.com/ebrescia.png?size=64"
|
||||||
alt="Erica Brescia"
|
alt="Erica Brescia"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/pedroapfilho" target="_blank" rel="noopener">
|
<a href="https://github.com/pedroapfilho" target="_blank" rel="noopener">
|
||||||
<img
|
<img
|
||||||
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
||||||
src="https://github.com/pedroapfilho.png?size=128"
|
src="https://github.com/pedroapfilho.png?size=64"
|
||||||
alt="Pedro Filho"
|
alt="Pedro Filho"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/peterp" target="_blank" rel="noopener">
|
<a href="https://github.com/peterp" target="_blank" rel="noopener">
|
||||||
<img
|
<img
|
||||||
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
||||||
src="https://github.com/peterp.png?size=128"
|
src="https://github.com/peterp.png?size=64"
|
||||||
alt="Peter Pistorius"
|
alt="Peter Pistorius"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="http://tom.preston-werner.com" target="_blank" rel="noopener">
|
<a href="http://tom.preston-werner.com" target="_blank" rel="noopener">
|
||||||
<img
|
<img
|
||||||
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
||||||
src="https://github.com/mojombo.png?size=128"
|
src="https://github.com/mojombo.png?size=64"
|
||||||
alt="Tom Preston-Werner"
|
alt="Tom Preston-Werner"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/mlynch" target="_blank" rel="noopener">
|
<a href="https://github.com/mlynch" target="_blank" rel="noopener">
|
||||||
<img
|
<img
|
||||||
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
||||||
src="https://github.com/mlynch.png?size=128"
|
src="https://github.com/mlynch.png?size=64"
|
||||||
alt="Max Lynch"
|
alt="Max Lynch"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/rawkode" target="_blank" rel="noopener">
|
<a href="https://github.com/rawkode" target="_blank" rel="noopener">
|
||||||
<img
|
<img
|
||||||
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
||||||
src="https://github.com/rawkode.png?size=128"
|
src="https://github.com/rawkode.png?size=64"
|
||||||
alt="David McKay"
|
alt="David McKay"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/brianshaler" target="_blank" rel="noopener">
|
<a href="https://github.com/brianshaler" target="_blank" rel="noopener">
|
||||||
<img
|
<img
|
||||||
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
||||||
src="https://github.com/brianshaler.png?size=128"
|
src="https://github.com/brianshaler.png?size=64"
|
||||||
alt="Brian Shaler"
|
alt="Brian Shaler"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/mxstbr" target="_blank" rel="noopener">
|
<a href="https://github.com/mxstbr" target="_blank" rel="noopener">
|
||||||
<img
|
<img
|
||||||
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
||||||
src="https://github.com/mxstbr.png?size=128"
|
src="https://github.com/mxstbr.png?size=64"
|
||||||
alt="Max Stoiber"
|
alt="Max Stoiber"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/jjcaine" target="_blank" rel="noopener">
|
<a href="https://github.com/jjcaine" target="_blank" rel="noopener">
|
||||||
<img
|
<img
|
||||||
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
style="max-width: 64px; max-height: 64px; border-radius: 100%"
|
||||||
src="https://github.com/jjcaine.png?size=128"
|
src="https://github.com/jjcaine.png?size=64"
|
||||||
alt="John Caine"
|
alt="John Caine"
|
||||||
/>
|
/>
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
#### Organizations
|
#### Organizations
|
||||||
|
|
||||||
Support this project with your organization. Your logo will show up here with a link to your website [[Contribute](https://opencollective.com/hoppscotch/contribute)].
|
Support this project with your organization. Your logo will show up here with a link to your website [[Support](#support)].
|
||||||
|
|
||||||
<a href="https://opencollective.com/hoppscotch/organization/0/website"><img src="https://opencollective.com/hoppscotch/organization/0/avatar.svg"></a>
|
<a href="https://opencollective.com/hoppscotch/organization/0/website"><img src="https://opencollective.com/hoppscotch/organization/0/avatar.svg"></a>
|
||||||
<a href="https://opencollective.com/hoppscotch/organization/1/website"><img src="https://opencollective.com/hoppscotch/organization/1/avatar.svg"></a>
|
<a href="https://opencollective.com/hoppscotch/organization/1/website"><img src="https://opencollective.com/hoppscotch/organization/1/avatar.svg"></a>
|
||||||
@@ -549,17 +552,17 @@ This project exists thanks to all the people who contribute [[Contribute](CONTRI
|
|||||||
|
|
||||||
<a href="https://github.com/hoppscotch/hoppscotch/graphs/contributors"><img src="https://opencollective.com/hoppscotch/contributors.svg?width=890&button=false" /></a>
|
<a href="https://github.com/hoppscotch/hoppscotch/graphs/contributors"><img src="https://opencollective.com/hoppscotch/contributors.svg?width=890&button=false" /></a>
|
||||||
|
|
||||||
## License 📄
|
## **License**
|
||||||
|
|
||||||
This project is licensed under the [MIT License](https://opensource.org/licenses/MIT) - see the [`LICENSE`](LICENSE) file for details.
|
This project is licensed under the [MIT License](https://opensource.org/licenses/MIT) - see the [`LICENSE`](LICENSE) file for details.
|
||||||
|
|
||||||
## 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**
|
||||||
|
|
||||||
<table>
|
<table>
|
||||||
<tr>
|
<tr>
|
||||||
|
|||||||
Reference in New Issue
Block a user