Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Asitha committed Feb 7, 2021
1 parent 28c1661 commit e423000
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 10 deletions.
44 changes: 34 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,34 @@
# VSCode Remote Try Ballerina
# VSCode Ballerina Development Container

## Before you begin

This Ballerina developer environment is created to work with VS Code Remote - Containers plugin. [Read more...](https://code.visualstudio.com/docs/remote/containers)
A development container is a running Docker 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 Remote - Containers](https://aka.ms/vscode-remote/containers).

- Install Docker in your developer environment
- Install Microsoft VS Code with *[Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)* plugin (`ms-vscode-remote.remote-containers
`)
- Use this template repository to create a Ballerina project repository
- Open the Project directory with VS Code and when prompted select the open in a dev container option
This is a template project for Ballerina language with VS Code development containers.

## Setting up the development container

## Open in Github Codespaces
Follow these steps to open this sample in a Codespace:

1. Click the Code drop-down menu and select the Open with Codespaces option.
![Open in codespaces](resources/use-with-codespaces.png)
2. Select + New codespace at the bottom on the pane.

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 Remote - Containers

Follow these steps to open this sample in a container using the VS Code Remote - 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).

1. Use this template repository to create a Ballerina project repository
![Use This Template](resources/use-as-a-template.png)
2. Clone the newly created repository to your local filesystem.
3. Press <kbd>F1</kbd> and select the **Remote-Containers: Open Folder in Container...** command.
![Open folder in container](resources/open-in-remote-container.png)
4. Select the cloned copy of this folder, wait for the container to start, and try things out!

## Create a Ballerina project

Expand All @@ -17,7 +37,11 @@ To create a Ballerina project open up the terminal in VSCode (`Terminal -> New T
```bash
$ bal init
```


Create a Ballerina module with
```bash
$ bal add <module_name>
```
----
> NOTE: Base docker image for the dev container is maintained at [VS Code Remote Ballerina-Dev Docker](https://github.com/Asitha/vscode-remote-ballerina-dev-container) repository.

Binary file added resources/open-in-remote-container.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/use-as-a-template.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/use-with-codespaces.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e423000

Please sign in to comment.