Skip to content
This repository has been archived by the owner on Nov 30, 2023. It is now read-only.

Commit

Permalink
Merge pull request #123 from dehru/salesforce/sfdx-project-container
Browse files Browse the repository at this point in the history
Salesforce/sfdx project container
  • Loading branch information
Chuxel committed Aug 28, 2019
2 parents 41cef30 + 3d9a57a commit 94f940d
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 0 deletions.
1 change: 1 addition & 0 deletions containers/sfdx-project/.devcontainer/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
FROM salesforce/salesforcedx
11 changes: 11 additions & 0 deletions containers/sfdx-project/.devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"name": "Salesforce Project",
"dockerFile": "Dockerfile",
"extensions": [
"salesforce.salesforcedx-vscode",
"redhat.vscode-xml",
"dbaeumer.vscode-eslint",
"esbenp.prettier-vscode"
]
}

3 changes: 3 additions & 0 deletions containers/sfdx-project/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
README.md
.vscode
.npmignore
43 changes: 43 additions & 0 deletions containers/sfdx-project/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# SFDX Project

## Summary

Salesforce Extension for VS Code supports remote development and allows you to use a docker container as a full-featured development environment.

| Metadata | Value |
|----------|-------|
| *Contributors* | Salesforce Developer Experience Teams |
| *Definition type* | Dockerfile |
| *Languages, Platforms* | Salesforce CLI, Lightning Web Components, Apex, Aura, Java, node.js, Javascript, HTML, CSS, Git |

## Description

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.

You can learn more about remote development with Salesforce Extension [here](https://forcedotcom.github.io/salesforcedx-vscode/).

## Using this definition with an existing folder

Just follow these steps:

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.

2. To use VS Code's copy of this definition:
1. Start VS Code and open your project folder.
2. Press <kbd>F1</kbd> and run **Remote-Containers: Add Development Container Configuration Files...** from the Command Palette.
3. Select the Salesforce Project definition.

3. To use latest-and-greatest copy of this definition from the repository:
1. Clone this repository.
2. Copy the contents of this folder in the cloned repository to the root of your project folder.
3. Start VS Code and open your project folder.

4. After step 2 or 3, edit the contents of the `.devcontainer` folder in your project, as required.

5. Start using the definition by running **Remote-Containers: Reopen Folder in Container** from the Command Palette.

## License

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE).

0 comments on commit 94f940d

Please sign in to comment.