diff --git a/README.md b/README.md index eff424e00..88681bc2a 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@

Screenshot @@ -78,34 +78,34 @@ **HTTP Methods** -- [x] `GET` - Requests retrieve resource information -- [x] `POST` - The server creates a new entry in a database -- [x] `PUT` - Updates an existing resource -- [x] `PATCH` - Very similar to `PUT` but makes a partial update on a resource -- [x] `DELETE` - Deletes resource or related component -- [x] `HEAD` - Retrieve response headers identical to those of a GET request, but without the response body. -- [x] `CONNECT` - Establishes a tunnel to the server identified by the target resource -- [x] `OPTIONS` - Describe the communication options for the target resource -- [x] `TRACE` - Performs a message loop-back test along the path to the target resource -- [x] `` - Some APIs use custom request methods such as `LIST`. Type in your custom methods. +- `GET` - Requests retrieve resource information +- `POST` - The server creates a new entry in a database +- `PUT` - Updates an existing resource +- `PATCH` - Very similar to `PUT` but makes a partial update on a resource +- `DELETE` - Deletes resource or related component +- `HEAD` - Retrieve response headers identical to those of a GET request, but without the response body. +- `CONNECT` - Establishes a tunnel to the server identified by the target resource +- `OPTIONS` - Describe the communication options for the target resource +- `TRACE` - Performs a message loop-back test along the path to the target 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 โ€” [customize now โœจ](https://hoppscotch.io/settings). **Theming** -- [x] Choose theme: System (default), Light, Dark and Black -- [x] Choose accent color: Green (default), Teal, Blue, Indigo, Purple, Yellow, Orange, Red and Pink -- [x] Distraction free Zen mode +- Choose theme: System (default), Light, Dark and Black +- Choose accent color: Green (default), Teal, Blue, Indigo, Purple, Yellow, Orange, Red and Pink +- Distraction free Zen mode _Customized themes are synced with cloud / local session_ ๐Ÿ”ฅ **PWA:** Install as a [PWA](https://developers.google.com/web/progressive-web-apps) on your device. -- [x] Instant loading with Service Workers -- [x] Offline support -- [x] Low RAM/memory and CPU usage -- [x] Add to Home Screen -- [x] Desktop PWA +- Instant loading with Service Workers +- Offline support +- Low RAM/memory and CPU usage +- Add to Home Screen +- Desktop PWA ๐Ÿš€ **Request:** Retrieve response from endpoint instantly. @@ -113,10 +113,10 @@ _Customized themes are synced with cloud / local session_ 2. Enter `URL` 3. Send -- [x] Copy/share public "Share URL" -- [x] Generate/copy request code snippets for 10+ languages and frameworks -- [x] Import `cURL` -- [x] Label requests +- Copy/share public "Share URL" +- Generate/copy request code snippets for 10+ languages and frameworks +- Import `cURL` +- Label requests ๐Ÿ”Œ **WebSocket:** Establish full-duplex communication channels over a single TCP connection. @@ -128,19 +128,19 @@ _Customized themes are synced with cloud / local session_ ๐Ÿ”ฎ **GraphQL:** GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. -- [x] Set endpoint and get schema -- [x] Multi-column docs -- [x] Set custom request headers -- [x] Query schema -- [x] Get query response +- Set endpoint and get schema +- Multi-column docs +- Set custom request headers +- Query schema +- Get query response ๐Ÿ” **Authorization:** Allows to identify the end user. -- [x] None -- [x] Basic -- [x] Bearer Token -- [x] OAuth 2.0 -- [x] OIDC Access Token/PKCE +- None +- Basic +- Bearer Token +- OAuth 2.0 +- OIDC Access Token/PKCE ๐Ÿ“ข **Headers:** Describes the format the body of your request is being sent as. @@ -148,42 +148,42 @@ _Customized themes are synced with cloud / local session_ ๐Ÿ“ƒ **Request Body:** Used to send and receive data via the REST API. -- [x] Set `Content Type` -- [x] FormData, JSON and many more -- [x] Toggle between key-value and RAW input parameter list +- Set `Content Type` +- FormData, JSON and many more +- Toggle between key-value and RAW input parameter list ๐Ÿ‘‹ **Response:** Contains the status line, headers and the message/response body. -- [x] Copy response to clipboard -- [x] Download response as a file -- [x] View response headers -- [x] View raw and preview of HTML, image, JSON, XML responses +- Copy response to clipboard +- Download response as a file +- View response headers +- View raw and preview of HTML, image, JSON, XML responses โฐ **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. -- [x] Unlimited collections, folders and requests -- [x] Nested folders -- [x] Export and import as file or GitHub gist +- Unlimited collections, folders and requests +- Nested folders +- Export and import as file or GitHub gist _Collections are synced with cloud / local session storage_ ๐ŸŒ **Proxy:** Enable Proxy Mode from Settings to access blocked APIs. -- [x] Hide your IP address -- [x] Fixes [`CORS`](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) (Cross Origin Resource Sharing) issues -- [x] Access APIs served in non-HTTPS `[http://]` endpoints -- [x] Use your own Proxy URL +- Hide your IP address +- Fixes [`CORS`](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) (Cross Origin Resource Sharing) issues +- Access APIs served in non-HTTPS `[http://]` endpoints +- Use your own Proxy URL _Official proxy server is hosted by Hoppscotch - **[GitHub](https://github.com/hoppscotch/proxyscotch)** - **[Privacy Policy](https://docs.hoppscotch.io/privacy)**_ ๐Ÿ“œ **Pre-Request Scripts ฮฒ:** Snippets of code associated with a request that are executed before the request is sent. -- [x] Set environment variables -- [x] Include timestamp in the request headers -- [x] Send a random alphanumeric string in the URL parameters -- [x] Any JavaScript functions +- Set environment variables +- Include timestamp in the request headers +- Send a random alphanumeric string in the URL parameters +- Any JavaScript functions ๐Ÿ“„ **API Documentation:** Create and share dynamic API documentation easily, quickly. @@ -193,7 +193,7 @@ _Official proxy server is hosted by Hoppscotch - **[GitHub](https://github.com/h โŒจ๏ธ **Keyboard Shortcuts:** Optimized for efficiency. -> **[Shortcuts](https://docs.hoppscotch.io/features/shortcuts)** +> **[Read our documentation on Keyboard Shortcuts](https://docs.hoppscotch.io/features/shortcuts)** ๐ŸŒŽ **i18n:** Experience the app in your own language. @@ -215,29 +215,29 @@ _Add-ons are developed and maintained under **[Hoppscotch Organization](https:// **Sign in with** -- [x] GitHub -- [x] Google -- [x] Email +- GitHub +- Google +- Email **Synchronize your data** -- [x] History -- [x] Collections -- [x] Environments -- [x] Settings +- History +- Collections +- Environments +- Settings โœ… **Post-Request Tests ฮฒ:** Write tests associated with a request that are executed after the request response. -- [x] Check the status code as an integer -- [x] Filter response headers -- [x] Parse the response data -- [x] Any JavaScript functions +- Check the status code as an integer +- Filter response headers +- Parse the response data +- Any JavaScript functions ๐ŸŒฑ **Environments** : Environment variables allow you to store and reuse values in your requests and scripts. -- [x] Unlimited environments and variables -- [x] Initialize through pre-request script -- [x] Export as / import from GitHub gist +- Unlimited environments and variables +- Initialize through pre-request script +- Export as / import from GitHub gist

Use-cases @@ -254,9 +254,9 @@ _Add-ons are developed and maintained under **[Hoppscotch Organization](https:// ๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ฆ **Teams ฮฒ:** Helps you collaborate across your team to design, develop, and test APIs faster. -- [x] Unlimited team collections and shared requests -- [x] Unlimited team members -- [x] User roles +- Unlimited team collections and shared requests +- Unlimited team members +- User roles **For more features, please read our [documentation](https://docs.hoppscotch.io).** @@ -288,7 +288,8 @@ _Sample keys only works with the [production build](https://hoppscotch.io)._ ### Browser based development environment -[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/hoppscotch/hoppscotch) +- [GitHub codespace](https://docs.github.com/en/codespaces/developing-in-codespaces/creating-a-codespace) +- [Gitpod](https://gitpod.io/#https://github.com/hoppscotch/hoppscotch) ### Local development environment diff --git a/components/app/Sidenav.vue b/components/app/Sidenav.vue index b1e49a40d..287e5b886 100644 --- a/components/app/Sidenav.vue +++ b/components/app/Sidenav.vue @@ -14,7 +14,7 @@
- {{ navigation.title }} + {{ navigation.title }} + + -
diff --git a/components/landing/Screenshot.vue b/components/landing/Screenshot.vue new file mode 100644 index 000000000..f0ca3c62f --- /dev/null +++ b/components/landing/Screenshot.vue @@ -0,0 +1,19 @@ + diff --git a/components/smart/LoadingIndicator.vue b/components/smart/LoadingIndicator.vue new file mode 100644 index 000000000..59b1015e4 --- /dev/null +++ b/components/smart/LoadingIndicator.vue @@ -0,0 +1,5 @@ + diff --git a/layouts/default.vue b/layouts/default.vue index 98e110db3..d9a2d16cc 100644 --- a/layouts/default.vue +++ b/layouts/default.vue @@ -11,7 +11,6 @@ :horizontal="!(windowInnerWidth >= 768)" > @@ -120,7 +119,6 @@ export default defineComponent({ updateThemes() return { - LEFT_SIDEBAR: useSetting("LEFT_SIDEBAR"), ZEN_MODE: useSetting("ZEN_MODE"), } }, diff --git a/locales/en.json b/locales/en.json index 0b2e733ff..d132b97a3 100644 --- a/locales/en.json +++ b/locales/en.json @@ -204,7 +204,7 @@ "hide": { "more": "Hide more", "preview": "Hide Preview", - "sidebar": "Hide sidebar" + "sidebar": "Collapse sidebar" }, "import": { "collections": "Import collections", @@ -386,7 +386,7 @@ "show": { "code": "Show code", "more": "Show more", - "sidebar": "Show sidebar" + "sidebar": "Expand sidebar" }, "socketio": { "communication": "Communication", diff --git a/pages/enter.vue b/pages/enter.vue index 850dd7cb4..c97814783 100644 --- a/pages/enter.vue +++ b/pages/enter.vue @@ -1,11 +1,7 @@ diff --git a/static/images/screenshots/banner_dark.png b/static/images/screenshots/banner_dark.png deleted file mode 100644 index c373579ef..000000000 Binary files a/static/images/screenshots/banner_dark.png and /dev/null differ diff --git a/static/images/screenshots/banner_light.png b/static/images/screenshots/banner_light.png deleted file mode 100644 index edf88ab19..000000000 Binary files a/static/images/screenshots/banner_light.png and /dev/null differ diff --git a/static/images/screenshots/light_graphql.png b/static/images/screenshots/light_graphql.png new file mode 100644 index 000000000..e56d89e38 Binary files /dev/null and b/static/images/screenshots/light_graphql.png differ diff --git a/static/images/screenshots/light_rest.png b/static/images/screenshots/light_rest.png new file mode 100644 index 000000000..3e4399f98 Binary files /dev/null and b/static/images/screenshots/light_rest.png differ