Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/dzucconi/kiosk

Last synced: 10 days ago
JSON representation

Host: GitHub
URL: https://github.com/dzucconi/kiosk
Owner: dzucconi
Created: 2020-12-28T22:59:32.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2023-12-14T21:06:40.000Z (11 months ago)
Last Synced: 2024-10-12T15:02:27.993Z (24 days ago)
Language: TypeScript
Homepage: https://kiosk.work.damonzucconi.com/
Size: 106 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # Kiosk

[![Netlify Status](https://api.netlify.com/api/v1/badges/f1cbb54d-787a-4d2f-a2bf-4eeb4371e0fa/deploy-status)](https://app.netlify.com/sites/damonzucconi-kiosk/deploys)

## Meta

- **State**: production

- **Production**:

  - **URL**: https://kiosk.work.damonzucconi.com/

  - **URL**: https://damonzucconi-kiosk.netlify.app/

- **Host**: https://app.netlify.com/sites/damonzucconi-kiosk/overview

- **Deploys**: Merged PRs to `dzucconi/kiosk#master` are automatically deployed to production. [Manually trigger a deploy](https://app.netlify.com/sites/damonzucconi-kiosk/deploys)

## Parameters

| Param        | Description                                                   | Type                      | Default                                  |

| ------------ | ------------------------------------------------------------- | ------------------------- | ---------------------------------------- |

| `id`         | Auspic.es collection ID                                       | `string`                  | `"49ee7cb3-a05a-463b-9ebb-5c1b59787d1b"` |

| `interval`   | Time in milliseconds between refreshes                        | `number`                  | `1800000` (30 minutes)                   |

| `mode`       | Either display iframed content or the list of available links | `"display" \| "overview"` | `"display"`                              |

| `hideCursor` | Positions a fullscreen div over the frame that hides cursor   | `boolean`                 | `true`                                   |

## As a script tag

By embedding as a script tag on every page contained within the collection: bypass iframing the content. The script will redirect to a randomly chosen URL once the interval passes.

```javascript

```