ICT ALMA Common Software

Space shortcuts

Page tree

VisualStudio Code (VS Code) is the recommended coding tool for the development of ACS workshop due to it's ability to use LiveShare, which allows to work collaboratively easily between group members.

Install VS Code

Follow the instructions of the VS Code documentation to download and install depending on your operating system.

→ https://code.visualstudio.com/download


LiveShare

Live Share enables you to quickly collaborate with other people on the same code without the need to sync code or to configure the same development tools, settings, or environment.

In the case of the ACS workshop it will be very useful to work in the project, hosting a LiveShare session from the ACS Virtual Machine and sharing it with each member of your group.

See more details of VS Code LiveShare in the official documentation: https://code.visualstudio.com/learn/collaboration/live-share

Install LiveShare extension

You will need to install the extension of LiveShare only in your personal computer, unless you are the person hosting the LiveShare session from inside the Virtual Machine, in which case you need to install it in the Virtual Machine too. More details in Host a LiveShare session.

  • 1. In your personal computer, open VS Code.
  • 2. Click on the "Extensions" icon and search "LiveShare". Install the first package that shows in the search:

           

Host a LiveShare session

In order to be able to host a LiveShare session, you will need a GitHub or Microsoft account to login.

In this tutorial in particular, we will host the LiveShare session from inside the ACS Virtual Machine to make it easier to collaboratively work on the project, this will also allow to use ACS to compile and run your component more easily and quickly.

Only one of the members of your group is needed to be the host of the LiveShare session, but is encouraged for all members to learn how to host a LiveShare session.

  • 1. Install LiveShare extension in the VS Code inside the Virtual Machine.
  • 2. Open the ACS Workshop repository with VS Code inside the VM.
  • 3. Click on the LiveShare icon and select the option "Share":

                           

  • 4. The first time you will be requested to login using your Microsoft or GitHub account. Follow the instructions.
  • 5. Once the LiveShare session is ready, the link to the LiveShare session should be copied on your clipboard. If you need to copy it again, click the LiveShare icon that is on the lower part of the VS Code interface and copy link again. You can also share the terminal which can be useful for other members to run ACS.

                   

  • 6. Login on your email from inside the Virtual Machine and send an email to the other members of the group with the LiveShare link so they can join.

Join a LiveShare session.

From your personal computer, all you have to do is to open the LiveShare session link that the host member created, this will automatically open VS Code and join the session.

Alternatively, you can copy the LiveShare session link, open VS Code, click the LiveShare icon on the left of the VS Code interface, click the option "Join" and paste the LiveShare session link.

Working in the shared session

Once you enter the LiveShare session you will be able to see the repository and work in it creating files and writing in files. As the members of your group edit the files, you will see their changes live.

From the LiveShare icon on the left of VS Code interface you can also join a Session chat, which can be useful to send other members links or bash commands.

Finally, if the LiveShare session host enabled the option "share terminal" (see #Host a LiveShare session), if you open the terminal of VS Code you will be able to run commands on the Virtual Machine of the host, including running ACS commands.


  • No labels