Skip to content

[OBSOLETE] Instructions for 15th NDN Hackathon

Jump to bottom
Xinyu Ma edited this page Jul 21, 2024 · 1 revision

Notices Before Started

  • Suggested browsers: Chrome or Edge 111+.
    • Firefox 111+ and Chrome for Android have problems with a small feature, but good generally. Safari is not tested.
  • Please open one tab at one time.
  • Manual refresh (F5 or Ctrl+R) will reload everything, disconnecting from both the testbed and the workspace.

Get Started

Connect to the testbed

You can connect to the testbed and obtain a testbed certificate using the following the steps. You will need an email to receive the PIN code.

  • Click Connection on the left panel.
  • Click ADD.
  • Click REACH TESTBED to find a closest testbed node.
  • Fill in an email address and click REQUEST.
  • Check your inbox and spam folder, write down the PIN code and click GET CERT
  • Now you have obtained a valid certificate and saved the connection profile. The saved profile should start with wss. Typically, it is wss://suns.cs.ucla.edu/ws/ if you applied in LA.
  • Click the green triangle to connect to the testbed node.

Bootstrap to the Hackathon demo workspace

We have set up an NDN certificate server for demonstrations in retreat and hackathon.

  • Make sure you are connected to a testbed node with a valid certificate.
  • Click Workspace on the left panel.
  • Click HACKATHON in the top, right corner.
  • Click the azure JOIN button.
  • You will see a page with the base64 encoded trust anchor and your certificate. Your credentials will be saved for future use.

However, if you do this before the demo in the retreat, the workspace is likely to be completely empty, since no one has created the test workspace. Please use the debug workspace to try out other functions.

Demonstration

bootstrap

LaTeX file editing

Open a file

  • Click LaTeX on the left panel
  • You are supposed to see at least main.tex in the root folder. Click the file to open a code editor.
  • Feel free to write anything, and other connected peers should see your editing soon.

Create a shared code file

  • Click the menu icon and then select New tex.
    • The type of file cannot be modified after creation.
  • Give a name and click ADD.
    • If the name is duplicated, the existing file will be opened instead of creating a new one.

Blob files

Blob files are those binary files such as figures and pdfs. Real-time collaborative editing is not supported, but you can upload a new version to replace the old one.

  • Click the menu icon and then select Upload blob.
  • Click UPLOAD and select the file you want to upload.
  • You can modify the file name now.
    • Known issue: the cross button is not working. Also, there may be some problem if you click UPLOAD again.
  • Click ADD to upload the file.
    • Uploading a file with an existing name will replace the existing version with the new one.

Shared rich doc

A rich doc is a shared document edited with shared rich text editor. You can create one by clicking the menu icon and then select New rich doc. A rich doc always has the extension of .xml.

Download as ZIP

This function allows you to download a tarball containing all files.

  • Click the menu icon and then select Download as ZIP.
  • Note: in some case there may be multiple files with the same name in the same folder. When exporting, only one version will be saved.

Map to a local disk folder

This feature is only supported on the PC version of Chrome and Edge 111+. After folder mapping, workspace files will be synced up with a folder in the local disk, and you can edit them in a normal text editor.

  • Click the menu button and then select Map to a folder
  • Select a folder to sync files. An empty folder is preferred, as existing files may be overwritten.
  • Click Edit files to allow the app to modify the disk folder.
  • Then, the sync is set up. Remote updates to the workspace will be reflected into the disk file upon receiption, and local edits will be uploaded to the workspace regularly after saving.
    • Rich docs will not be synced.
    • You can only create a new file in the web app. Files you created locally will not be synced.
    • Make sure only one person is editting one file at one time. Otherwise, there is a chance of conflict. You can shutdown the connection and work in the offline mode to ensure this.
  • To end the sync, you need to navigate to a different browser page such as Workspace or Connection.

Please check here for more details.

A-Frame AR demo

  • After the workspace is running, click A-Frame on the left panel.
  • Use WASD to move. Use mouse drag to move camera.
  • Click to create boxes. They will be synced with other peers.
Clone this wiki locally