Skip to content

About

Client-only React PWA starter with GitHub Actions Pake desktop releases

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

Client PWA + Pake Desktop Starter

A small, client-only React PWA foundation with a validated GitHub Actions release path for Pake desktop packages. It is intentionally product-neutral: use it as a starting point for local-first tools, then replace the starter UI and identity with your product.

What is included

Capability Included behavior
Browser PWA Web app manifest, install prompt, service worker, and offline application shell
Client-only baseline No API client, database, analytics, or background server is included
Quality gate Type checking, a small regression suite, and production build verification on pushes and pull requests
Desktop packaging Pake CLI creates native Windows, macOS, and Linux packages from dist/public
Release automation Pushing a v* tag creates a GitHub Release and attaches the desktop packages

Privacy boundary: this starter is deliberately free of remote data flows. Any network request, server route, tracking script, or third-party SDK should be an explicit product decision.

Quick start

pnpm install
pnpm dev
Command Purpose
pnpm check Type-check the project
pnpm test Run regression tests
pnpm build Build the browser PWA into dist/public
pnpm preview Inspect the production browser build locally

Customize in this order

  1. Rename the application in client/src/lib/app-config.ts, client/index.html, and client/public/manifest.webmanifest.
  2. Replace client/public/icon.svg and desktop/app-icon.svg with your product icon.
  3. Replace client/src/App.tsx and update client/src/styles.css with your product interface.
  4. Update the APP_* values in .github/workflows/desktop-release.yml.
  5. Expand the regression suite before shipping functionality.

GitHub Actions

verify.yml runs checks, tests, and a standard PWA build on main pushes and pull requests. desktop-release.yml supports manual package validation and creates a GitHub Release automatically for tags beginning with v.

git tag -a v0.1.0 -m "Release v0.1.0"
git push origin v0.1.0

The desktop workflow packages the local static build, not a hosted URL. It includes the Rust, Linux WebKit, and Windows short-path setup needed for the tested Pake CLI release matrix. See desktop/README.md for branding and signing details.

Before public distribution

Native installers are unsigned by default. Add Windows code signing, macOS notarization, and release checksums before distributing publicly. Pake powers the desktop workflow; see tw93/Pake and consider supporting its maintainers.

About

Client-only React PWA starter with GitHub Actions Pake desktop releases

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages