Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add installation steps from VScode #67

Merged
merged 1 commit into from
Apr 26, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 2 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,8 @@ Installation consists of two parts: the front-end UI (this repository) and [Deep

### Frontend Installation
To install, either:
* [Download](https://centml-releases.s3.us-east-2.amazonaws.com/deepview-explore/index.html) the prebuilt VSCode plugin package
* Build it from source
1. Prerequisites:
- node.js v14+
- [Protobuf Compiler](https://grpc.io/docs/protoc-installation/)
- npm install -g @vscode/vsce (to build the vscode extension)
2. Run the following commands
```bash
git clone https://github.com/CentML/DeepView.Explore.git
./scripts/build_vsix.sh
```
3. The vsix file will be generated in the current working directory

Once you have the vsix file, run `code --install-extension deepview-explore-*.vsix` to install the extension.
**Note: the file [build_vsix_dev.sh] is only to be used for development**
* Install it from [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=CentML.deepview-explore)
* Install directly from VSCode by searching for DeepView

**Adding cloud instances to the Deployment Tab:** You can include information about the instances that you use through the extension settings. There you will find an option named **providers** that accepts a list of urls separated by commas. Each url must be a JSON file that follows the schema specified here: [schema](deepview-explore/react-ui/src/schema/CloudProvidersSchema.js).<br/>
Additionally, you need to add the necessary access so the extension can read the file.<br/>
Expand Down