Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lucbpz/svelte-template-docker-extension

A sample Docker Desktop extension that uses Svelte for the Frontend
https://github.com/lucbpz/svelte-template-docker-extension

docker-extension docker-extensions

Last synced: 7 days ago
JSON representation

A sample Docker Desktop extension that uses Svelte for the Frontend

Awesome Lists containing this project

README 

        
# Svelte extension



This repository defines an example of a Docker extension. The files in this repository have been automatically generated as a result of running `docker extension init`.



This extension is composed of:



- A [frontend](./ui) app in React that makes a request to the `/hello` endpoint and displays the payload in Docker Desktop.

- A [backend](./backend) container that runs an API in Go. It exposes the `/hello` endpoint which returns a JSON payload.



> You can build your Docker Extension using your fav tech stack:

>

> - Frontend: React, Angular, Vue, Svelte, etc.

>   Basically, any frontend framework you can bundle in an `index.html` file with CSS, and JS assets.

> - Backend (optional): anything that can run in a container.



  Looking for more templates?



1. [React + NodeJS](https://github.com/benja-M-1/node-backend-extension).

2. [React + .NET 6 WebAPI](https://github.com/felipecruz91/dotnet-api-docker-extension).



Request one or submit yours [here](https://github.com/docker/extensions-sdk/issues).



## Local development



You can use `docker` to build, install and push your extension. Also, we provide an opinionated [Makefile](Makefile) that could be convenient for you. There isn't a strong preference of using one over the other, so just use the one you're most comfortable with.



To build the extension, use `make build-extension` **or**:



```shell

  docker buildx build -t lucasbernalte981/svelte-extension:latest . --load

```



To install the extension, use `make install-extension` **or**:



```shell

  docker extension install lucasbernalte981/svelte-extension:latest

```



> If you want to automate this command, use the `-f` or `--force` flag to accept the warning message.



To preview the extension in Docker Desktop, open Docker Dashboard once the installation is complete. The left-hand menu displays a new tab with the name of your extension. You can also use `docker extension ls` to see that the extension has been installed successfully.



### Frontend development



During the development of the frontend part, it's helpful to use hot reloading to test your changes without rebuilding your entire extension. To do this, you can configure Docker Desktop to load your UI from a development server.

Assuming your app runs on the default port, start your UI app and then run:



```shell

  cd ui

  npm install

  npm run dev

```



This starts a development server that listens on port `3000`.



You can now tell Docker Desktop to use this as the frontend source. In another terminal run:



```shell

  docker extension dev ui-source lucasbernalte981/svelte-extension:latest http://localhost:3000

```



In order to open the Chrome Dev Tools for your extension when you click on the extension tab, run:



```shell

  docker extension dev debug lucasbernalte981/svelte-extension:latest

```



Each subsequent click on the extension tab will also open Chrome Dev Tools. To stop this behaviour, run:



```shell

  docker extension dev reset lucasbernalte981/svelte-extension:latest

```



### Backend development (optional)



This example defines an API in Go that is deployed as a backend container when the extension is installed. This backend could be implemented in any language, as it runs inside a container. The extension frameworks provides connectivity from the extension UI to a socket that the backend has to connect to on the server side.



Note that an extension doesn't necessarily need a backend container, but in this example we include one for teaching purposes.



Whenever you make changes in the [backend](./backend) source code, you will need to compile them and re-deploy a new version of your backend container.

Use the `docker extension update` command to remove and re-install the extension automatically:



```shell

docker extension update lucasbernalte981/svelte-extension:latest

```



> If you want to automate this command, use the `-f` or `--force` flag to accept the warning message.



> Extension containers are hidden from the Docker Dashboard by default. You can change this in Settings > Extensions > Show Docker Extensions system containers.



### Clean up



To remove the extension:



```shell

docker extension rm lucasbernalte981/svelte-extension:latest

```



## What's next?



- To learn more about how to build your extension refer to the Extension SDK docs at https://docs.docker.com/desktop/extensions-sdk/.

- To publish your extension in the Marketplace visit https://www.docker.com/products/extensions/submissions/.

- To report issues and feedback visit https://github.com/docker/extensions-sdk/issues.

- To look for other ideas of new extensions, or propose new ideas of extensions you would like to see, visit https://github.com/docker/extension-ideas/discussions.