https://github.com/zenml-io/vscode-quickstart
https://github.com/zenml-io/vscode-quickstart
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zenml-io/vscode-quickstart
- Owner: zenml-io
- Created: 2024-07-03T17:34:56.000Z (11 months ago)
- Default Branch: develop
- Last Pushed: 2024-08-26T07:51:12.000Z (10 months ago)
- Last Synced: 2025-03-01T15:41:20.798Z (3 months ago)
- Size: 7.65 MB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Welcome to the ZenML VSCode Quickstart 👋
## Introduction
This repository is home to the ZenML VS Code Quickstart. The quickstart is a VS Code extension that will guide you through getting started with ZenML.
## Running in GitHub Codespaces
To run this extension directly in GitHub Codespaces, follow these steps:
1. Click on the "Code" button and select "Open with Codespaces".
2. Once the Codespace is ready (This will take a few minutes), the extension will automatically load within your development environment.
## Running Locally
To run this extension locally, follow these steps:
### Step 1: Clone the Repository
Clone the repository to your local machine
### Step 2: Install Dependencies
- [Visual Studio Code](https://code.visualstudio.com/Download)
- [Docker](https://www.docker.com/get-started/)
- [Dev Containers Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
### Step 3: Load the Extension in VS Code
1. Open Visual Studio Code.
2. You should be prompted to open the project in a devcontainer if you have the Dev Containers extension installed. If not, open the project by selecting "Dev Containers: Reopen in Container" from the VS Code command palette.
3. Once the container is built (will take a few minutes, depending on your network connection and hardware) and prerequisites are installed the extension will open in the Dev Container.
## Usage
Once the extension is loaded, follow the tutorial to learn how to use ZenML!
## Contributing
If you're interested in contributing, please head over to the development repository [here](https://github.com/zenml-io/vscode-quickstart-extension).