generated from microsoft/vscode-remote-try-java
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
4 additions
and
90 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,91 +1,5 @@ | ||
| # Try Out Development Containers: Java | ||
| # For Those Who Want to Contribute! | ||
| - Fork this repository and add your own code | ||
| - Please make sure that it runs correctly for projectStem | ||
| - Comment out any projectStem dependencies when uploading code | ||
|
|
||
| [](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/vscode-remote-try-java) | ||
|
|
||
| A **development container** is a running container with a well-defined tool/runtime stack and its prerequisites. You can try out development containers with **[GitHub Codespaces](https://github.com/features/codespaces)** or **[Visual Studio Code Dev Containers](https://aka.ms/vscode-remote/containers)**. | ||
|
|
||
| This is a sample project that lets you try out either option in a few easy steps. We have a variety of other [vscode-remote-try-*](https://github.com/search?q=org%3Amicrosoft+vscode-remote-try-&type=Repositories) sample projects, too. | ||
|
|
||
| > **Note:** If you already have a Codespace or dev container, you can jump to the [Things to try](#things-to-try) section. | ||
| ## Setting up the development container | ||
|
|
||
| ### GitHub Codespaces | ||
| Follow these steps to open this sample in a Codespace: | ||
| 1. Click the **Code** drop-down menu. | ||
| 2. Click on the **Codespaces** tab. | ||
| 3. Click **Create codespace on main**. | ||
|
|
||
| For more info, check out the [GitHub documentation](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace#creating-a-codespace). | ||
|
|
||
| ### VS Code Dev Containers | ||
|
|
||
| If you already have VS Code and Docker installed, you can click the badge above or [here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/vscode-remote-try-java) to get started. Clicking these links will cause VS Code to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use. | ||
|
|
||
| Follow these steps to open this sample in a container using the VS Code Dev Containers extension: | ||
|
|
||
| 1. If this is your first time using a development container, please ensure your system meets the pre-reqs (i.e. have Docker installed) in the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started). | ||
|
|
||
| 2. To use this repository, you can either open the repository in an isolated Docker volume: | ||
|
|
||
| - Press <kbd>F1</kbd> and select the **Dev Containers: Try a Sample...** command. | ||
| - Choose the "Java" sample, wait for the container to start, and try things out! | ||
| > **Note:** Under the hood, this will use the **Dev Containers: Clone Repository in Container Volume...** command to clone the source code in a Docker volume instead of the local filesystem. [Volumes](https://docs.docker.com/storage/volumes/) are the preferred mechanism for persisting container data. | ||
| Or open a locally cloned copy of the code: | ||
|
|
||
| - Clone this repository to your local filesystem. | ||
| - Press <kbd>F1</kbd> and select the **Dev Containers: Open Folder in Container...** command. | ||
| - Select the cloned copy of this folder, wait for the container to start, and try things out! | ||
|
|
||
| ## Things to try | ||
|
|
||
| Once you have this sample opened, you'll be able to work with it like you would locally. | ||
|
|
||
| Some things to try: | ||
|
|
||
| 1. **Edit:** | ||
| - Open `src/main/java/com/mycompany/app/App.java`. | ||
| - Try adding some code and check out the language features. | ||
| - Make a spelling mistake and notice it is detected. The [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) extension was automatically installed because it is referenced in `.devcontainer/devcontainer.json`. | ||
| - Also notice that the [Extension Pack for Java](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack) is installed. The JDK is in the `mcr.microsoft.com/devcontainers/java` image and Dev Container settings and metadata are automatically picked up from [image labels](https://containers.dev/implementors/reference/#labels). | ||
|
|
||
| 2. **Terminal:** Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>\`</kbd> and type `uname` and other Linux commands from the terminal window. | ||
|
|
||
| 3. **Build, Run, and Debug:** | ||
| - Open `src/main/java/com/mycompany/app/App.java`. | ||
| - Add a breakpoint. | ||
| - Press <kbd>F5</kbd> to launch the app in the container. | ||
| - Once the breakpoint is hit, try hovering over variables, examining locals, and more. | ||
|
|
||
| 4. **Run a Test:** | ||
| - Open `src/test/java/com/mycompany/app/AppTest.java`. | ||
| - Put a breakpoint in a test. | ||
| - Click the `Debug Test` in the Code Lens above the function and watch it hit the breakpoint. | ||
|
|
||
| 5. **Install Node.js using a Dev Container Feature:** | ||
| - Press <kbd>F1</kbd> and select the **Dev Containers: Configure Container Features...** or **Codespaces: Configure Container Features...** command. | ||
| - Type "node" in the text box at the top. | ||
| - Check the check box next to "Node.js (via nvm) and yarn" (published by devcontainers) | ||
| - Click OK | ||
| - Press <kbd>F1</kbd> and select the **Dev Containers: Rebuild Container** or **Codespaces: Rebuild Container** command so the modifications are picked up. | ||
|
|
||
|
|
||
| ## Contributing | ||
|
|
||
| This project welcomes contributions and suggestions. Most contributions require you to agree to a | ||
| Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us | ||
| the rights to use your contribution. For details, visit https://cla.microsoft.com. | ||
|
|
||
| When you submit a pull request, a CLA-bot will automatically determine whether you need to provide | ||
| a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions | ||
| provided by the bot. You will only need to do this once across all repos using our CLA. | ||
|
|
||
| This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
| For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or | ||
| contact [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
|
|
||
| ## License | ||
|
|
||
| Copyright © Microsoft Corporation All rights reserved.<br /> | ||
| Licensed under the MIT License. See LICENSE in the project root for license information. |