codecentric / web-clip

A Chrome extension to extract structured data from any web page and store it to a Solid Pod.

WebClip

A Chrome extension to extract structured data from any web page and store it to a Solid Pod.

Install

You can install the extension easily via the Chrome Web Store.

Start locally

First install all dependencies by running

npm install

Limited development mode via Webpack dev server

To run a pure web application version of the extension execute

npm run dev

Be aware that this mode mocks the chrome API and not everything will work the same way as the real extension would. So make sure to always test the full extension via chrome.

You can use the WebClip popup on the example page with a login to the local development pod.

The option page can also be opened via the icon in the UI, or directly visited at http://localhost:8080/options.html.

Some features, like granting access to a remote pod, can not be tested that way, but the limited dev mode is a good way to test simple UI-focused changes, without having to rebuild and reload the whole plugin.

To test the real extension, integrated with the browser API, see section "Full extension via chrome".

Local pod for testing

You need Docker to do this.

To start a Community Solid Server instance locally for testing run:

npm run pod:up

The server will be running as a docker container in the background and can be accessed on http://localhost:3000.

The data of it is stored at ./dev/pod.

Log in
email	[e-mail]
password	webclip-dev-pod

To view the server logs run:

npm run pod:logs

To stop the server execute:

npm run pod:down

Full extension via chrome

To start webpack in watch mode run

npm start

In Chrome:

1. visit chrome://extensions/
2. enable the developer mode
3. Load unpacked extension (choose the project's build folder)

Release on Chrome Web Store

All commits to the main branch trigger a Github Actions CI/CD build, that creates or updates a draft release with the version from package.json. The ZIP file can then be downloaded locally and uploaded manually via the Chrome Developer Dashboard. To create an official release on GitHub, the release step in the CI/CD Github Action needs to be triggered manually.