Skip to content

Latest commit

 

History

History
67 lines (51 loc) · 2.77 KB

getting_started.md

File metadata and controls

67 lines (51 loc) · 2.77 KB

Weblets project

Weblets are a web components which provide a UI to deploy workloads on TF Grid 3. all the backend functionality is provided by grid_client. It is a reusable component that can be injected in a HTML or a Node Web app.

Repo structure

The repo contains two projects:

  • The weblets itself as the components.
    • which written in Svelte
    • available in the / directory.
  • The playground as a web app where you can try out the weblets.
    • which written in Vue
    • available in the /playground directory.

Usage

You can use one of the live instances of the playground:

Or run the playground locally: First you need to Install dependencies and config the environment

Then, to run the playground you need to first build the weblets then move the built files to the /playground directory. to serve it. and this can be done with yarn serve:app script.

yarn deps           # to install the dependencies
yarn serve:app      # to build, move, and serve the playground

For targeted build you can export the TARGET_WEBLETS environment variable to build only the weblets you want. the value is the name of the folder in src/elements/ directory seperated by space. for example:

export TARGET_WEBLETS="vm peertube DeployedList"
yarn serve:app

To read about each weblet and how to use it, and also how to config your twin id and activate your profile on the playground you can go to the weblets documentation.

Weblet List

There is a several component in the weblets repo, you can find them in the /src/elements directory. and they are: