feat: desktop app port (issue #23)#24
Merged
ThisIs-Developer merged 5 commits intoThisIs-Developer:mainfrom Feb 18, 2026
Merged
feat: desktop app port (issue #23)#24ThisIs-Developer merged 5 commits intoThisIs-Developer:mainfrom
ThisIs-Developer merged 5 commits intoThisIs-Developer:mainfrom
Conversation
…tion using Neutralinojs.
…r build - Add prepare.js build script to copy/transform shared browser-version files (script.js, styles.css, assets/, index.html) into resources/ - Add package.json with dev, build (embedded), build:portable, and build:all npm scripts using @neutralinojs/neu CLI - Add multi-stage Dockerfile and docker-compose.yml for containerized builds without local toolchain - Add GitHub Actions workflow (desktop-build.yml) triggered on desktop-v* tags to build and publish release assets (executables, portable ZIPs, source archive, SHA256 checksums) - Update .gitignore for build artifacts, node_modules, and Docker output - Add .dockerignore to exclude generated resources and build artifacts - Update index.html with Neutralinojs script injections and app wrapper - Update styles.css (desktop-specific overrides inherited from upstream) - Add README with architecture, dev setup, build instructions (npm + npx + Docker), and release documentation
- Remove `npm install` requirements from README, Dockerfile, and CI. - Update package.json scripts to use `npx -y` for all neutralino commands. - Simplify build instructions to rely on npm scripts abstraction.
`neu build` requires platform binaries in `bin/`, which are gitignored and absent on fresh clones — producing an empty `dist/` folder. Add [setup-binaries.js](cci:7://file:///c:/personal/personal/dev/forks/markdown-viewer-fork/desktop-app/setup-binaries.js:0:0-0:0) which downloads binaries via `neu update` only when missing or when the pinned version in [neutralino.config.json](cci:7://file:///c:/personal/personal/dev/forks/markdown-viewer-fork/desktop-app/neutralino.config.json:0:0-0:0) changes, tracked by a `bin/.version` marker file. Wire it into the npm script chain via `setup` + `postsetup` hooks so that `npm run dev`, `npm run build`, and `npm run build:all` all ensure binaries exist before proceeding. - Simplify Dockerfile from 3 stages to 2 (setup handled by npm hooks) - Add explicit setup step in GitHub Actions workflow - Update README with setup documentation
|
@ramezio is attempting to deploy a commit to the ThisIs-Developer Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Desktop App Port (Neutralinojs)
Adds a lightweight desktop application version of Markdown Viewer using Neutralinojs, as proposed in #23.
Motivation
Provide a native desktop experience (primarily Windows, but cross-platform) without the overhead of Electron. The resulting Windows x64 binary is ~8.65 MB.
Architecture
The desktop app shares its core files (
script.js,styles.css,assets/) with the browser version — nothing is duplicated or forked. A build script (prepare.js) copies and transforms these files intodesktop-app/resources/at build time, injecting Neutralinojs-specific script tags and wrapper elements intoindex.html.Neutralinojs platform binaries are managed by
setup-binaries.js, which downloads them on first use and caches them inbin/(gitignored). The download is version-locked tocli.binaryVersioninneutralino.config.jsonand only re-triggered when that version changes.Desktop-only files:
resources/js/main.js— Neutralinojs lifecycle, tray menu, window eventsresources/js/neutralino.js— Neutralinojs client libraryneutralino.config.json— App configurationsetup-binaries.js— Idempotent binary setup (downloads on first use)What's Included
package.jsonwithsetup,dev,build(embedded single-file),build:portable(ZIP bundle), andbuild:allscripts — binaries are auto-downloaded on first run viasetup-binaries.js.github/workflows/desktop-build.yml) triggered ondesktop-v*tags — sets up binaries, builds and publishes embedded executables, portable ZIPs, source archives, and SHA256 checksums as GitHub Release assetsDockerfile+docker-compose.ymlto build binaries without any local toolchainREADME.mdcovering architecture, development setup, build instructions (npm / npx / Docker), and release conventionsRelease Assets (per GitHub Release)
markdown-viewer-win_x64.exemarkdown-viewer-linux_x64.tar.gzmarkdown-viewer-linux_arm64.tar.gzmarkdown-viewer-mac_*.tar.gzmarkdown-viewer-release.zipsource.tar.gzSHA256SUMS.txtHow to Test