Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gristlabs/grist-widget
A repository of custom widgets to embed in Grist documents
https://github.com/gristlabs/grist-widget
Last synced: 3 months ago
JSON representation
A repository of custom widgets to embed in Grist documents
- Host: GitHub
- URL: https://github.com/gristlabs/grist-widget
- Owner: gristlabs
- License: apache-2.0
- Created: 2020-08-17T13:50:56.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-05T21:20:33.000Z (3 months ago)
- Last Synced: 2024-08-06T00:24:35.024Z (3 months ago)
- Language: JavaScript
- Homepage: https://gristlabs.github.io/grist-widget/
- Size: 699 KB
- Stars: 50
- Watchers: 5
- Forks: 55
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - gristlabs/grist-widget - A repository of custom widgets to embed in Grist documents (others)
README
# grist-widget
A repository of Grist custom widgets that have no back-end requirements.
# Custom hosting
To use this repository for your own Grist instance, you need to copy all the files to
your own hosting provider and recreate the manifest.json file used by Grist.
```bash
yarn install
yarn run build
```
To tell your Grist instance to use your repository set the `GRIST_WIDGET_LIST_URL`
environmental variable to URL of the manifest.json file, for example
```bash
GRIST_WIDGET_LIST_URL=https://manifest.json npm start
```
# Developing
To run a local widget server in a watch mode, with automatic reload use:
```bash
yarn install
yarn run dev
```
This will start local development server that will host contents of this repository,
recreate the manifest.json file on every change and replace `grist-plugin-api.js` URL to
one provided by your own Grist instance, assuming it is available at
http://localhost:8484, to override the port use:
```bash
GRIST_PORT= yarn run dev
```
Next start Grist with an URL pointing to a local widget manifest file:
```bash
GRIST_WIDGET_LIST_URL=http://localhost:8585/manifest.json npm start
```