Sticky Clip

Sticky Clip is a monorepo with the desktop app and its web document site.

Requirements

• Node.js 20+
• Yarn 1.22.x

Workspace Layout

• apps/app: Electron desktop app
• apps/document: product/document website
• packages/*: shared assets, hooks, configs, types, and utilities

Development

Install dependencies:

yarn install

Run the desktop app:

yarn dev:app

Run the document site:

yarn dev:document

Build

Build everything managed by Turbo:

yarn build

Build only the desktop app:

yarn build:app

Build only the document site:

yarn build:document

Deploy

Deploy the document site manually:

yarn deploy:document

GitHub Actions also deploys apps/document/dist to gh-pages on pushes to main.