README.md (hoppscotch-2.2.1) | : | README.md (hoppscotch-3.0.0) | ||
---|---|---|---|---|
skipping to change at line 37 | skipping to change at line 37 | |||
<p> | <p> | |||
<sub> | <sub> | |||
Built with ❤︎ by | Built with ❤︎ by | |||
<a href="https://github.com/hoppscotch/hoppscotch/graphs/contributors"> | <a href="https://github.com/hoppscotch/hoppscotch/graphs/contributors"> | |||
contributors | contributors | |||
</a> | </a> | |||
</sub> | </sub> | |||
</p> | </p> | |||
<br /> | <br /> | |||
<p> | <p> | |||
<a href="https://hoppscotch.io"> | <a href="https://hoppscotch.io/#gh-light-mode-only" target="_blank"> | |||
<img | <img | |||
src="https://raw.githubusercontent.com/hoppscotch/hoppscotch/main/packag | src="./packages/hoppscotch-app/static/images/banner-light.png" | |||
es/hoppscotch-app/static/banner.png" | alt="Hoppscotch" | |||
alt="Screenshot" | width="100%" | |||
/> | ||||
</a> | ||||
<a href="https://hoppscotch.io/#gh-dark-mode-only" target="_blank"> | ||||
<img | ||||
src="./packages/hoppscotch-app/static/images/banner-dark.png" | ||||
alt="Hoppscotch" | ||||
width="100%" | width="100%" | |||
/> | /> | |||
</a> | </a> | |||
</p> | </p> | |||
</div> | </div> | |||
#### **Support** | #### **Support** | |||
[](https://hoppscotch.io/discord) [](https://hoppscotch.io/telegram) [](https://github.com/hoppscotch/hoppscotch/discussions) | [](https://hoppscotch.io/discord) [](https://hoppscotch.io/telegram) [](https://github.com/hoppscotch/hoppscotch/discussions) | |||
<details open> | ||||
<summary><b>Table of contents</b></summary> | ||||
- [Features](#features) | ||||
- [Demo](#demo) | ||||
- [Usage](#usage) | ||||
- [Built with](#built-with) | ||||
- [Developing](#developing) | ||||
- [Docker](#docker) | ||||
- [Releasing](#releasing) | ||||
- [Contributing](#contributing) | ||||
- [Continuous Integration](#continuous-integration) | ||||
- [Changelog](#changelog) | ||||
- [Authors](#authors) | ||||
- [License](#license) | ||||
</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. | |||
**HTTP Methods** | **HTTP Methods** | |||
- `GET` - Requests retrieve resource information | - `GET` - Requests retrieve resource information | |||
- `POST` - The server creates a new entry in a database | - `POST` - The server creates a new entry in a database | |||
skipping to change at line 102 | skipping to change at line 87 | |||
🌈 **Make it yours:** Customizable combinations for background, foreground, and a ccent colors — [customize now](https://hoppscotch.io/settings). | 🌈 **Make it yours:** Customizable combinations for background, foreground, and a ccent colors — [customize now](https://hoppscotch.io/settings). | |||
**Theming** | **Theming** | |||
- Choose a theme: System (default), Light, Dark, and Black | - Choose a theme: System (default), Light, Dark, and Black | |||
- Choose accent color: Green (default), Teal, Blue, Indigo, Purple, Yellow, Oran ge, Red, and Pink | - Choose accent color: Green (default), Teal, Blue, Indigo, Purple, Yellow, Oran ge, Red, and Pink | |||
- Distraction-free Zen mode | - Distraction-free Zen mode | |||
_Customized themes are synced with cloud / local session_ | _Customized themes are synced with cloud / local session_ | |||
🔥 **PWA:** Install as a [PWA](https://developers.google.com/web/progressive-web- apps) on your device. | 🔥 **PWA:** Install as a [PWA](https://web.dev/what-are-pwas/) on your device. | |||
- Instant loading with Service Workers | - Instant loading with Service Workers | |||
- Offline support | - Offline support | |||
- Low RAM/memory and CPU usage | - Low RAM/memory and CPU usage | |||
- Add to Home Screen | - Add to Home Screen | |||
- Desktop PWA | - Desktop PWA | |||
🚀 **Request:** Retrieve response from endpoint instantly. | 🚀 **Request:** Retrieve response from endpoint instantly. | |||
1. Choose `method` | 1. Choose `method` | |||
skipping to change at line 222 | skipping to change at line 207 | |||
- **[Hopp-Doc-Gen](https://github.com/hoppscotch/hopp-doc-gen)** - An API doc ge nerator CLI for Hoppscotch | - **[Hopp-Doc-Gen](https://github.com/hoppscotch/hopp-doc-gen)** - An API doc ge nerator CLI for Hoppscotch | |||
_Add-ons are developed and maintained under **[Hoppscotch Organization](https:// github.com/hoppscotch)**._ | _Add-ons are developed and maintained under **[Hoppscotch Organization](https:// github.com/hoppscotch)**._ | |||
☁️ **Auth + Sync:** Sign in and sync your data in real-time. | ☁️ **Auth + Sync:** Sign in and sync your data in real-time. | |||
**Sign in with** | **Sign in with** | |||
- GitHub | - GitHub | |||
- Microsoft | ||||
**Synchronize your data** | **Synchronize your data** | |||
- History | - History | |||
- Collections | - Collections | |||
- Environments | - Environments | |||
- Settings | - Settings | |||
✅ **Post-Request Tests β:** Write tests associated with a request that is execut ed after the request's response. | ✅ **Post-Request Tests β:** Write tests associated with a request that is execut ed after the request's response. | |||
- 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 | |||
- Any JavaScript functions | - Set environment variables | |||
- Write JavaScript code | ||||
🌱 **Environments** : Environment variables allow you to store and reuse values i n your requests and scripts. | 🌱 **Environments** : Environment variables allow you to store and reuse values i n your requests and scripts. | |||
- Unlimited environments and variables | - Unlimited environments and variables | |||
- Initialize through the pre-request script | - Initialize through the pre-request script | |||
- Export as / import from GitHub gist | - Export as / import from GitHub gist | |||
<details> | <details> | |||
<summary><i>Use-cases</i></summary> | <summary><i>Use-cases</i></summary> | |||
skipping to change at line 270 | skipping to change at line 257 | |||
- Unlimited shared collections | - Unlimited shared collections | |||
- Unlimited team members | - Unlimited team members | |||
- Role-based access control | - Role-based access control | |||
- Cloud sync | - Cloud sync | |||
- Multiple devices | - Multiple devices | |||
🚚 **Bulk Edit:** Edit key-value pairs in bulk. | 🚚 **Bulk Edit:** Edit key-value pairs in bulk. | |||
- Entries are separated by newline | - Entries are separated by newline | |||
- Keys and values are separated by `:` | - Keys and values are separated by `:` | |||
- Prepend `//` to any row you want to add but keep disabled | - Prepend `#` to any row you want to add but keep disabled | |||
**For more features, please read our [documentation](https://docs.hoppscotch.io) .** | **For more features, please read our [documentation](https://docs.hoppscotch.io) .** | |||
## **Demo** | ## **Demo** | |||
[hoppscotch.io](https://hoppscotch.io) | [hoppscotch.io](https://hoppscotch.io) | |||
## **Usage** | ## **Usage** | |||
1. Provide your API endpoint in the URL field | 1. Provide your API endpoint in the URL field | |||
2. CLick "Send" to simulate the request | 2. Click "Send" to simulate the request | |||
3. View the response | 3. View the response | |||
## **Built with** | ## **Built with** | |||
- [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML) | - [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML) | |||
- [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS), [SCSS](https://sass-l ang.com), [Windi CSS](https://windicss.org) | - [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS), [SCSS](https://sass-l ang.com), [Windi CSS](https://windicss.org) | |||
- [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) | - [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) | |||
- [TypeScript](https://www.typescriptlang.org) | - [TypeScript](https://www.typescriptlang.org) | |||
- [Vue](https://vuejs.org) | - [Vue](https://vuejs.org) | |||
- [Nuxt](https://nuxtjs.org) | - [Nuxt](https://nuxtjs.org) | |||
skipping to change at line 331 | skipping to change at line 318 | |||
```bash | ```bash | |||
docker run --rm --name hoppscotch -p 3000:3000 hoppscotch/hoppscotch:latest | docker run --rm --name hoppscotch -p 3000:3000 hoppscotch/hoppscotch:latest | |||
``` | ``` | |||
## **Releasing** | ## **Releasing** | |||
1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) w ith git. | 1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) w ith git. | |||
2. Install pnpm using npm by running `npm install -g pnpm`. | 2. Install pnpm using npm by running `npm install -g pnpm`. | |||
3. Install dependencies by running `pnpm install` within the directory that you cloned (probably `hoppscotch`). | 3. Install dependencies by running `pnpm install` within the directory that you cloned (probably `hoppscotch`). | |||
4. Build the release files with `pnpm run generate`. | 4. Update [`.env.example`](https://github.com/hoppscotch/hoppscotch/blob/main/pa | |||
5. Find the built project in `packages/hoppscotch-app/dist`. | ckages/hoppscotch-app/.env.example) file found in `packages/hoppscotch-app` with | |||
your own keys and rename it to `.env`. | ||||
5. Build the release files with `pnpm run generate`. | ||||
6. Find the built project in `packages/hoppscotch-app/dist`. Host these files on | ||||
any [static hosting servers](https://www.pluralsight.com/blog/software-developm | ||||
ent/where-to-host-your-jamstack-site). | ||||
## **Contributing** | ## **Contributing** | |||
Please contribute using [GitHub Flow](https://guides.github.com/introduction/flo w). Create a branch, add commits, and [open a pull request](https://github.com/h oppscotch/hoppscotch/compare). | Please contribute using [GitHub Flow](https://guides.github.com/introduction/flo w). Create a branch, add commits, and [open a pull request](https://github.com/h oppscotch/hoppscotch/compare). | |||
Please read [`CONTRIBUTING`](CONTRIBUTING.md) for details on our [`CODE OF CONDU CT`](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us. | Please read [`CONTRIBUTING`](CONTRIBUTING.md) for details on our [`CODE OF CONDU CT`](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us. | |||
## **Continuous Integration** | ## **Continuous Integration** | |||
We use [GitHub Actions](https://github.com/features/actions) for continuous inte gration. Check out our [build workflows](https://github.com/hoppscotch/hoppscotc h/actions). | We use [GitHub Actions](https://github.com/features/actions) for continuous inte gration. Check out our [build workflows](https://github.com/hoppscotch/hoppscotc h/actions). | |||
End of changes. 9 change blocks. | ||||
30 lines changed or deleted | 23 lines changed or added |