Skip to content

Commit 2074ecc

Browse files
Update README.md
Adding a description for the VS Code extension
1 parent bbbcbbc commit 2074ecc

File tree

1 file changed

+33
-63
lines changed

1 file changed

+33
-63
lines changed

README.md

Lines changed: 33 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,33 @@
1-
# Redis for Visual Studio Code
2-
3-
Temporary repository to work on the VS Code extension
4-
5-
### yarn is required
6-
1. `npm i -g yarn`
7-
1. `yarn install`
8-
1. Download backend for your platform using `yarn download:backend`
9-
1. Click on the VSCode sidebar `Run and Debug` icon
10-
1. Chose one of the options in the select control and click on the green play icon. Options:
11-
a. `Run Dev Extension` - start 2 background dev tasks and the debug vscode instance with extension
12-
b. `Run only Extension` - start only the debug vscode instance with extension
13-
1. In the opened Visual studio code instance, click the Redis for VS Code icon in the sidebar
14-
15-
16-
17-
### Scripts:
18-
`download:backend` - download backend for current platform
19-
`dev` - run web server with custom router in the `RI_DATA_ROUTE` env variable. Like `RI_DATA_ROUTE=settings yarn dev`
20-
`dev:sidebar` - run web server with sidebar router
21-
`l10n:collect` - auto find all new strings and add them to `./l10n/bundle.l10n.json`
22-
`storybook:dev` - run web storybook dev server
23-
`package:prod` - package plugin as *.vsix file for prod
24-
`package:stage` - package plugin as *.vsix file as prerelease build
25-
26-
`watch` - start node part of the plugin in dev mode
27-
`build` - build web part of the plugin and run in dev mode
28-
29-
### Docs for all people:
30-
[vsc toolkit storybook](https://microsoft.github.io/vscode-webview-ui-toolkit/)
31-
[vsc toolkit figma](https://www.figma.com/file/PYCyGCOqN7gCFRnoPnbgqH/Visual-Studio-Code-Toolkit-(Community)?type=design&node-id=1-2&mode=design&t=IfTmvBc9Bh8KuMTy-0)
32-
33-
### Docs for developers
34-
#### Technologies:
35-
[tailwind](https://tailwindcss.com/)
36-
[msw](https://mswjs.io/) (mock be responses)
37-
[storybook ](https://storybook.js.org/)
38-
[storybook + msw](https://github.com/mswjs/msw-storybook-addon) (mock BE response)
39-
[storybook + vitest](https://storybook.js.org/addons/@storybook/testing-react) (use stories as component for tests)
40-
[vsc icons](https://react-icons.github.io/react-icons/icons?name=vsc)
41-
42-
[vite](https://vitejs.dev/)
43-
[vitest](https://vitest.dev/)
44-
45-
#### Visual studio code
46-
[vsc extension overview](https://code.visualstudio.com/api/extension-guides/overview)
47-
[vsc extension webview ](https://code.visualstudio.com/api/extension-guides/webview)
48-
[How to Code a VSCode Extension](https://youtu.be/a5DX5pQ9p5M) (youtube)
49-
50-
51-
#### Visual studio code plugins
52-
[tailwind vsc plugin](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss)
53-
[vitest vcs plugin](https://marketplace.visualstudio.com/items?itemName=ZixuanChen.vitest-explorer)
54-
55-
The `F5` command starts 3 tasks:
56-
* dev mode for node vsc
57-
* dev mode for web view
58-
* open a new vsc instance with the plugin
59-
60-
`F5` is a shortcut to start the "Run and Debug" => "Run Dev Extension" task
61-
62-
To run only vsc instance without background dev tasks chose:
63-
"Run and Debug" => "Run only Extension"
1+
# <img src="https://github.com/RedisInsight/Redis-for-VS-Code/blob/main/src/resources/256x256.png" alt="logo" width="25"/> Redis for VS Code
2+
3+
Redis for VS Code is the official Visual Studio Code extension that provides an intuitive and efficient GUI for Redis databases, developed by Redis.
4+
5+
![Redis for VS Code](.github/Redis_for_VS_Code_main_screen.png)
6+
7+
## Key features:
8+
* Universal Redis Support: Connect to any Redis instance, including Redis Community Edition, Redis Cloud, Redis Software, and Redis on Azure Cache.
9+
* Advanced Connectivity: Supports TLS certificates and SSH tunnels, with an option for automatic data decompression for GZIP, SNAPPY, Brotli, and more.
10+
* Data types: Supports strings, hashes, lists, sets, sorted sets, and JSON.
11+
* Human-readable data representation: Offers formatters like ASCII, JSON, Binary, Hex, 32-bit, and 64-bit vectors, and other.
12+
* Integrated Redis CLI: Leverage Redis CLI with syntax preview as you type commands.
13+
14+
For more details, check out the [release notes](https://github.com/RedisInsight/Redis-for-VS-Code/releases).
15+
16+
## Get started with Redis for VS Code
17+
18+
This repository contains the source code for the Redis for VS Code extension. To start using the extension, install it from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/vscode).
19+
20+
## Feedback
21+
22+
We welcome your feedback and contributions to make Redis for VS Code even better. Here’s how you can get involved:
23+
24+
* Suggest a new [feature](https://github.com/RedisInsight/Redis-for-VS-Code/issues/new?assignees=&labels=&projects=&template=feature_request.md&title=)
25+
* Upvote [popular feature requests](https://github.com/RedisInsight/Redis-for-VS-Code/issues?q=is%3Aissue+is%3Aopen+sort%3Acomments-desc)
26+
* Report a [bug](https://github.com/RedisInsight/Redis-for-VS-Code/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=%5BBUG%5D)
27+
28+
## Telemetry
29+
30+
Redis for VS Code includes an opt-in telemetry system to help us improve the developer experience. We respect your privacy — any data collected is anonymized. You can disable telemetry at any time via the extension’s settings page.
31+
32+
## License
33+
Redis for VS Code is licensed under the [SSPL](/LICENSE).

0 commit comments

Comments
 (0)