{"id":29583531,"url":"https://github.com/fiforms/revelation-electron-wrapper","last_synced_at":"2026-04-03T05:04:23.578Z","repository":{"id":304085074,"uuid":"1016959521","full_name":"fiforms/revelation-electron-wrapper","owner":"fiforms","description":"Revelation Snapshot Presenter - Full Installer with Electron","archived":false,"fork":false,"pushed_at":"2026-04-02T05:15:12.000Z","size":3713,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-02T18:40:42.857Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fiforms.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2025-07-09T19:51:30.000Z","updated_at":"2026-04-02T05:15:16.000Z","dependencies_parsed_at":"2026-02-27T05:02:18.895Z","dependency_job_id":null,"html_url":"https://github.com/fiforms/revelation-electron-wrapper","commit_stats":null,"previous_names":["fiforms/revelation-electron-wrapper"],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/fiforms/revelation-electron-wrapper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fiforms%2Frevelation-electron-wrapper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fiforms%2Frevelation-electron-wrapper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fiforms%2Frevelation-electron-wrapper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fiforms%2Frevelation-electron-wrapper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fiforms","download_url":"https://codeload.github.com/fiforms/revelation-electron-wrapper/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fiforms%2Frevelation-electron-wrapper/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31335201,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-03T04:42:29.251Z","status":"ssl_error","status_checked_at":"2026-04-03T04:42:12.667Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-19T23:13:45.759Z","updated_at":"2026-04-03T05:04:23.573Z","avatar_url":"https://github.com/fiforms.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# REVELation Snapshot Builder\n\n---\n\n`revelation-electron-wrapper` is the cross-platform Electron desktop app for [REVELation Snapshot Presenter](https://github.com/fiforms/revelation).\n\nIt wraps the core REVELation framework with a local app experience: presentation management, metadata and markdown editing, media workflows, peering/network controls, and export tooling.\n\n---\n\n## 📦 Download and Install\n\n**Recommended for Most Users**  \nDownload the latest release from the [Releases Page](https://github.com/fiforms/revelation-electron-wrapper/releases) for Windows, Linux, and OSX\n\nJust run the installer, and you’re good to go!\n\nTroubleshooting notes (including Wayland/X11 launch guidance):\n\n* [doc/TROUBLESHOOTING.md](doc/TROUBLESHOOTING.md)\n\n---\n\n## 👨‍💻 Developer Setup (or manual install)\n\nIf you're a developer or prefer building from source:\n\n* [doc/dev/INSTALLING.md](doc/dev/INSTALLING.md)\n\n---\n\n## 💡 Project Scope\n\nThis repository is responsible for the desktop wrapper and app UX. It:\n\n* Launches a local Vite server to serve Reveal.js-based presentations\n* Starts a Reveal.js Remote server for remote control and multi-screen\n* Opens a full Electron window pointed to the local server\n* Provides GUI flows for editing, media import, and export\n* Bundles wrapper and framework resources for packaged/offline use\n\nCore markdown authoring syntax, macro processing, and framework internals live in the `revelation/` submodule.\n\n---\n\n## 🧩 About the REVELation Framework\n\nThe bundled `revelation/` submodule is a modular framework for building and presenting Markdown-based Reveal.js slide decks.\n\n---\n\nFor users installing `revelation-electron`, this is the engine behind the app experience:\n\n* Extended markdown authoring (front matter, macros, slide helpers, attributions)\n* Media-rich slide support (backgrounds, aliases, and reusable media references)\n* Reveal.js runtime integration with remote and handout workflows\n* File-based presentations that are easy to version and share\n\nIf you want the full framework overview and direct framework-first workflow, see:\n* [revelation/README.md](revelation/README.md)\n\n---\n\n## 📚 Documentation\n\nWrapper docs (this repository):\n\n* [doc/GUI_REFERENCE.md](doc/GUI_REFERENCE.md) - GUI workflows and user-facing wrapper behavior\n* [doc/SETTINGS.md](doc/SETTINGS.md) - field-by-field reference for the Settings screen\n* [doc/TROUBLESHOOTING.md](doc/TROUBLESHOOTING.md) - runtime troubleshooting notes (including Wayland/X11)\n* [doc/dev/INSTALLING.md](doc/dev/INSTALLING.md) - manual/developer installation from source\n\n---\n\n* [doc/dev/PLUGINS.md](doc/dev/PLUGINS.md) - plugin hooks used by the builder/export pipeline\n* [doc/dev/PEERING.md](doc/dev/PEERING.md) - discovery and pairing behavior\n* [doc/dev/README-PDF.md](doc/dev/README-PDF.md) - PDF import setup (Poppler) for Add Media\n* [doc/dev/BUILDING.md](doc/dev/BUILDING.md) - packaging and installer build instructions\n\n---\n\nFramework docs (submodule):\n\n* [revelation/README.md](revelation/README.md) - framework overview, quick start, and feature summary\n* [revelation/doc/REFERENCE.md](revelation/doc/REFERENCE.md) - top-level index for framework docs\n* [revelation/doc/AUTHORING_REFERENCE.md](revelation/doc/AUTHORING_REFERENCE.md) - markdown authoring syntax extensions\n* [revelation/doc/METADATA_REFERENCE.md](revelation/doc/METADATA_REFERENCE.md) - YAML front matter, macros, media aliases\n* [revelation/doc/ARCHITECTURE.md](revelation/doc/ARCHITECTURE.md) - framework architecture and extension model\n\n---\n\nPlugin-specific syntax and behaviors are documented in plugin-local README files (for example, [plugins/revealchart/README.md](plugins/revealchart/README.md)).\n\n---\n\n## 🛠 Build an Installer\n\nSee [doc/dev/BUILDING.md](doc/dev/BUILDING.md) for details.\n\n---\n\n## 🔗 Related Projects\n\n* 📽️ [REVELation Framework](https://github.com/fiforms/revelation) — Modular Reveal.js system with YAML-driven themes, macros, and media integration.\n\n---\n\n## 📜 License\n\nThis software itself is licensed under a permissive MIT-style license. However, the project release includes software that is licensed\nunder other more restrictive licenses such as the GNU General Public License (GPL) and the GNU LGPL, which places some restrictions on \nhow you can redistribute it. In particular, it must include some notice like this one with a link to the license and you must make\nthe source code available.\n\nPlease see [LICENSE.md](LICENSE.md) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffiforms%2Frevelation-electron-wrapper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffiforms%2Frevelation-electron-wrapper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffiforms%2Frevelation-electron-wrapper/lists"}