|
| 1 | +# SFDX Project |
| 2 | + |
| 3 | +## Summary |
| 4 | + |
| 5 | +Salesforce Extension for VS Code supports remote development and allows you to use a docker container as a full-featured development environment. |
| 6 | + |
| 7 | +| Metadata | Value | |
| 8 | +|----------|-------| |
| 9 | +| *Contributors* | Salesforce Developer Experience Teams | |
| 10 | +| *Definition type* | Dockerfile | |
| 11 | +| *Languages, Platforms* | Salesforce CLI, Lightning Web Components, Apex, Aura, Java, node.js, Javascript, HTML, CSS, Git | |
| 12 | + |
| 13 | +## Description |
| 14 | + |
| 15 | +Remote development in container environment is powered by the official Salesforce sfdx [image](https://hub.docker.com/r/salesforce/salesforcedx) on Docker Hub. Salesforce CLI, Java, node.js, and Git are pre-installed and configured in your container. You can open a project mounted into the container and edit with full IntelliSense (completions), code navigation, debugging, and more. |
| 16 | + |
| 17 | +You can learn more about remote development with Salesforce Extension [here](https://forcedotcom.github.io/salesforcedx-vscode/). |
| 18 | + |
| 19 | +## Using this definition with an existing folder |
| 20 | + |
| 21 | +Just follow these steps: |
| 22 | + |
| 23 | +1. If this is your first time using a development container, follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine. |
| 24 | + |
| 25 | +2. To use VS Code's copy of this definition: |
| 26 | + 1. Start VS Code and open your project folder. |
| 27 | + 2. Press <kbd>F1</kbd> and run **Remote-Containers: Add Development Container Configuration Files...** from the Command Palette. |
| 28 | + 3. Select the Salesforce Project definition. |
| 29 | + |
| 30 | +3. To use latest-and-greatest copy of this definition from the repository: |
| 31 | + 1. Clone this repository. |
| 32 | + 2. Copy the contents of this folder in the cloned repository to the root of your project folder. |
| 33 | + 3. Start VS Code and open your project folder. |
| 34 | + |
| 35 | +4. After step 2 or 3, edit the contents of the `.devcontainer` folder in your project, as required. |
| 36 | + |
| 37 | +5. Start using the definition by running **Remote-Containers: Reopen Folder in Container** from the Command Palette. |
| 38 | + |
| 39 | +## License |
| 40 | + |
| 41 | +Copyright (c) Microsoft Corporation. All rights reserved. |
| 42 | + |
| 43 | +Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE). |
0 commit comments