diff --git a/README.md b/README.md index 53120bf74..5a8b50884 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@
- hoppscotch.io logo + hoppscotch.io logo

- A free, fast and beautiful API request builder + Hoppscotch - A free, fast and beautiful API request builder

Helps you create requests faster, saving precious time on development - Subscribe

-[![Travis Build Status](https://img.shields.io/travis/com/hoppscotch/hoppscotch/master?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) [![Website](https://img.shields.io/website?url=https%3A%2F%2Fhoppscotch.io&logo=postwoman)](https://hoppscotch.io) [![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen)](CONTRIBUTING.md) [![Financial Contributors on Open Collective](https://img.shields.io/opencollective/all/hoppscotch?logo=Open-Collective&label=financial+contributors)](https://opencollective.com/hoppscotch) [![Donate on PayPal](https://img.shields.io/badge/support-PayPal-blue?logo=PayPal)](https://www.paypal.me/liyascthomas) [![Chat on Telegram](https://img.shields.io/badge/chat-Telegram-blueviolet?logo=Telegram)](https://t.me/hoppscotch) [![Chat on Discord](https://img.shields.io/badge/chat-Discord-violet?logo=discord)](https://discord.gg/GAMWxmR) [![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=postwoman)](https://hoppscotch.io) [![Travis Build Status](https://img.shields.io/travis/com/hoppscotch/hoppscotch/master?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)

@@ -21,59 +21,62 @@

---- - -**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)** -
Screenshot1
+#### **Contact** + +[![Chat on Telegram](https://img.shields.io/badge/chat-Telegram-2CA5E0?logo=Telegram)](https://t.me/hoppscotch) [![Chat on Discord](https://img.shields.io/badge/chat-Discord-7289DA?logo=discord)](https://discord.gg/GAMWxmR) + +#### **Support** + +[![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) +
Table of contents --- -- [Features](#features-) -- [Demo](#demo--) -- [Usage](#usage-) -- [Built with](#built-with-) -- [Developing](#developing-) +- [Features](#features) +- [Demo](#demo) +- [Usage](#usage) +- [Built with](#built-with) +- [Developing](#developing) - [Browser based development environment](#browser-based-development-environment) - [Local development environment](#local-development-environment) - [Docker compose](#docker-compose) -- [Docker](#docker--) -- [Releasing](#releasing-) -- [Contributing](#contributing-) -- [Continuous Integration](#continuous-integration--) -- [Versioning](#versioning--) -- [Change log](#change-log-) -- [Authors](#authors-) +- [Docker](#docker) +- [Releasing](#releasing) +- [Contributing](#contributing) +- [Continuous Integration](#continuous-integration) +- [Versioning](#versioning) +- [Changelog](#changelog) +- [Authors](#authors) - [Lead Developers](#lead-developers) - [Testing and Debugging](#testing-and-debugging) - [Collaborators](#collaborators-) - [Thanks](#thanks) - [Financial Contributors](#financial-contributors) + - [GitHub Sponsors](#github-sponsors) - [Organizations](#organizations) - [Individuals](#individuals) - [Code Contributors](#code-contributors) -- [License](#license-) -- [Acknowledgements](#acknowledgements-) -- [Badges](#badges-) +- [License](#license) +- [Acknowledgements](#acknowledgements) +- [Badges](#badges) ---
-### 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 - `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 - `` - 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) @@ -97,9 +100,9 @@ _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 - Offline support @@ -107,31 +110,31 @@ _Customized themes are synced with local session storage_ - Add to Home Screen - Desktop PWA -🚀 **Request**: Retrieve response from endpoint instantly. +🚀 **Request:** Retrieve response from endpoint instantly. - Choose `method` - Enter `URL` - Send -**Features:** +**Features** - Copy/share public "Share URL" - Generate/copy request code for `JavaScript XHR`, `Fetch` and `cURL` - Import `cURL` - 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 - 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 - Multi-column docs @@ -139,9 +142,9 @@ _Customized themes are synced with local session storage_ - Query schema - Get query response -🔐 **Authentication**: Allows to identify the end user. +🔐 **Authentication:** Allows to identify the end user. -**Types:** +**Types** - None - Basic @@ -149,33 +152,33 @@ _Customized themes are synced with local session storage_ - OAuth 2.0 - 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` - Add or remove 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 - Download response as a file - 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_ -🌐 **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 - 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)**_ -📜 **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 - 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 2. Export Collections and easily share your APIs with the rest of your team 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 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!**_ -📦 **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 - **[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)**._ -☁️ **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 - GitHub -**Sync:** +**Sync** - History - Collections - Environments - 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 - 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. -**Use-cases:** +**Use-cases** - 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 @@ -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).** -## Demo 🚀 [![Website](https://img.shields.io/website?url=https%3A%2F%2Fhoppscotch.io&logo=postwoman)](https://hoppscotch.io) +## **Demo** [hoppscotch.io](https://hoppscotch.io) -## Usage 💡 +## **Usage** 1. Choose `method` 2. Enter `URL` 3. Send request 4. Get response -## Built with 🔧 +## **Built with** -- HTML - For the web framework -- CSS - For styling components -- JavaScript - For magic! -- [Vue](https://vuejs.org/) -- [Nuxt](https://nuxtjs.org/) +- [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML) +- [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS), [SCSS](https://sass-lang.com), [Tailwind CSS](https://tailwindcss.com) +- [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) +- [Vue](https://vuejs.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`. @@ -305,7 +308,7 @@ _Sample keys only works with the [production build](https://hoppscotch.io)._ 2. Run `docker-compose up` 3. Open development site by going to [`http://localhost:3000`](http://localhost:3000) in your browser. -## Docker 🐳 [![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/liyasthomas/postwoman?logo=Docker)](https://hub.docker.com/r/liyasthomas/postwoman) +## **Docker** ```bash #pull @@ -318,32 +321,32 @@ docker build -t 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. 2. Install dependencies by running `npm install` within the directory that you cloned (probably `hoppscotch`). 3. Build the release files with `npm run build`. 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 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 💚 [![Travis Build Status](https://img.shields.io/travis/com/hoppscotch/hoppscotch?logo=Travis)](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). -## Versioning 🔖 [![GitHub release](https://img.shields.io/github/release/hoppscotch/hoppscotch/all?logo=GitHub)](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). -## Change log 📝 +## **Changelog** See the [`CHANGELOG`](CHANGELOG.md) file for details. -## Authors 🧙 +## **Authors** ### Lead Developers @@ -400,133 +403,133 @@ See the list of [contributors](https://github.com/hoppscotch/hoppscotch/graphs/c ### 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 Shivam Mishra Zach Silveira Harshit Pant Jan Piotrowski Anil Kumar Gabriel Peal Kristján Oddsson Don Okuda Erica Brescia Pedro Filho Peter Pistorius Tom Preston-Werner Max Lynch David McKay Brian Shaler Max Stoiber John Caine #### 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)]. @@ -549,17 +552,17 @@ This project exists thanks to all the people who contribute [[Contribute](CONTRI -## License 📄 +## **License** 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 - Inspirations: - [Dribbble](https://dribbble.com) -## Badges 📛 +## **Badges**