Skip to content

you-want/PinWall

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

41 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

English | ไธญๆ–‡

PinWall

A transparent sticky-note wall that pins your notes right onto the desktop.

PinWall is a sticky-note app that lives directly on your macOS desktop. Transparent windows, free dragging, smart reminders โ€” make every note feel present.

Desktop App (Core Product)

A native macOS desktop app built with Tauri v2.

Core Features

  • Transparent Desktop Window โ€” Fully transparent window; notes float directly on your wallpaper
  • Click-Through โ€” Clicking blank areas drops the window to the bottom layer, no desktop interference
  • Free Drag & Position โ€” Drag any note anywhere on screen; click to bring it to front
  • Smart Reminder Notifications โ€” Set reminder times; a standalone notification window pops up with a sound alert
  • Card Stack & Stash โ€” Stash unused notes into the stack area; expand and pin back with one click
  • 8 Gradient Color Themes โ€” Choose or randomly assign gradient colors when creating notes
  • macOS Window Controls โ€” Traffic-light buttons for close / minimize / fullscreen
  • Custom Backgrounds โ€” Upload background images with auto-rotation support
  • Opacity Control โ€” Slider to adjust window transparency
  • Keyboard Shortcuts โ€” โŒ˜โ‡งN to quick-create, Esc to close
  • Local Persistence โ€” All data saved to local disk, privacy-first
  • Tray Icon โ€” Always accessible from the system tray

Tech Stack

Layer Technology
Frontend Framework React 19 + TypeScript
Build Tool Vite
State Management Zustand + tauri-store
Desktop Framework Tauri v2 (Rust)
Cross-Window Sync Zustand shared stores
Local Storage tauri-plugin-fs (disk JSON)

Getting Started

Prerequisites

  • macOS 13+
  • Node.js 18+
  • pnpm
  • Rust (install via rustup)

Install & Run

# 1. Enter the desktop directory
cd desktop

# 2. Install dependencies
pnpm install

# 3. Start dev mode (frontend + Rust window)
pnpm tauri dev

Dev mode opens a transparent window covering the desktop with hot-reload support.

Build for Release

cd desktop
pnpm tauri build

Build artifacts (.dmg / .app) are output to desktop/src-tauri/target/release/bundle/.

Other Modules

Web App (/frontend)

Live: https://pinwall.raingpt.top

The web version of PinWall, offering online sticky-note functionality.

  • React 18 + Vite + TailwindCSS + Zustand
  • Masonry layout, drag-and-drop sorting, keyboard search (โŒ˜K)
  • Note sharing via links, Markdown / JSON export
cd frontend
pnpm install
pnpm dev          # http://localhost:5173

Backend (/backend)

Provides API services for the Web App.

  • Flask + SQLAlchemy + JWT
  • SQLite (dev) / PostgreSQL (production)
cd backend
pip install -r requirements.txt
python3 main.py   # http://localhost:8000

Website (/website)

Product landing page with i18n support (Chinese & English).

  • React 19 + Vite + TypeScript
  • Deployed on Vercel
cd website
pnpm install
pnpm dev          # http://localhost:9123

Project Structure

PinWall/
โ”œโ”€โ”€ desktop/          # ๐Ÿ–ฅ๏ธ Desktop App (Tauri v2, core product)
โ”‚   โ”œโ”€โ”€ src/          #   React frontend
โ”‚   โ”œโ”€โ”€ src-tauri/    #   Rust native layer
โ”‚   โ””โ”€โ”€ package.json
โ”œโ”€โ”€ frontend/         # ๐ŸŒ Web App
โ”‚   โ”œโ”€โ”€ src/
โ”‚   โ””โ”€โ”€ package.json
โ”œโ”€โ”€ backend/          # โš™๏ธ Backend API (Flask)
โ”‚   โ”œโ”€โ”€ app/
โ”‚   โ””โ”€โ”€ main.py
โ”œโ”€โ”€ website/          # ๐Ÿ“„ Product Website
โ”‚   โ”œโ”€โ”€ src/
โ”‚   โ””โ”€โ”€ package.json
โ””โ”€โ”€ flutter-template/ # ๐Ÿ“ฑ Flutter Template (experimental)

Download

  • macOS: GitHub Releases
  • Web App: Visit the live site (see deployment config)

Deployment

See DEPLOY.md for the full deployment workflow.

  • Desktop App: GitHub Actions auto-build โ†’ Releases
  • Web App: Auto-deployed on Vercel
  • Backend: Render / self-hosted + Gunicorn
  • Website: Vercel

License

MIT License โ€” see LICENSE.

About

๐Ÿ“Œ PinWall ๆ˜ฏไธ€ๆฌพ็›ดๆŽฅ้“บๅœจ macOS ๆกŒ้ขไธŠ็š„ไพฟ็ญพๅข™ๅบ”็”จใ€‚้€ๆ˜Ž็ช—ๅฃใ€่‡ช็”ฑๆ‹–ๆ‹ฝใ€ๆ™บ่ƒฝๆ้†’โ€”โ€”่ฎฉๆฏไธ€ๆกๅค‡ๅฟ˜้ƒฝๆœ‰ๅญ˜ๅœจๆ„Ÿใ€‚

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors