Skip to content

A dual-purpose macOS side panel combining note-taking (ZenNote) and personal finance tracking (ZenCash) into one elegant utility.

License

Notifications You must be signed in to change notification settings

zenbytes-id/zenside

Repository files navigation

ZenSide

A dual-purpose macOS side panel combining note-taking (ZenNote) and personal finance tracking (ZenCash) into one elegant utility.

Built with Claude Code License: MIT macOS

ZenSide Logo

Features

Note-Taking (ZenNote)

  • 🎯 Quick access side panel that slides from screen edge
  • ⌨️ Global keyboard shortcut (Cmd+Shift+S)
  • πŸ“ Markdown support with WYSIWYG editor
  • πŸ“ Folder organization with nested support
  • πŸ” Full-text search across all notes
  • πŸ’Ύ Filesystem sync with Git integration
  • 🎨 Color-coded folders and notes

Personal Finance (ZenCash)

  • πŸ’° Multiple pockets (accounts) for money management
  • πŸ“Š Track income, expenses, and transfers
  • 🏷️ Customizable categories with icons and colors
  • πŸ“ˆ Monthly summaries and balance tracking
  • πŸ’Ύ JSON-based storage with sync support

General

  • πŸŒ“ Runs in menu bar (no dock icon)
  • πŸ–±οΈ Hot bar for quick access from screen edge
  • πŸ”„ Git integration for version control
  • 🎨 Clean, minimal interface
  • ⚑ Fast and lightweight

Installation

Download

Download the latest release from GitHub Releases

Available formats:

  • .dmg - Drag and drop installer (Recommended)
  • .zip - Portable application

Build from Source

# Clone the repository
git clone https://github.com/zenbytes-id/zenside.git
cd zenside

# Install dependencies
npm install

# Run in development mode
npm start

# Build for production
npm run make

Usage

  1. Launch ZenSide - Click the menu bar icon or press Cmd+Shift+S
  2. Quick Access - Hover near the left edge of your screen to show the hot bar
  3. Create Notes - Click the hot bar or use the keyboard shortcut
  4. Organize - Create folders and organize your notes

Keyboard Shortcuts

  • Cmd+Shift+S - Toggle panel visibility
  • Cmd+F - Open search (shows panel if hidden)
  • Menu bar β†’ Quit - Exit application

Development

# Install dependencies
npm install

# Start development server
npm start

# Package application
npm run package

# Create distributable
npm run make

# Lint code
npm run lint

Building for Distribution

Code Signing (macOS)

To distribute ZenSide, you'll need an Apple Developer account and code signing certificate.

See docs/APPLE_CODE_SIGNING.md for detailed setup instructions.

Quick setup:

cp .env.example .env
# Edit .env with your Apple Developer credentials
./build-release.sh

This will create signed and notarized .dmg and .zip files in out/make/.

For development builds without signing:

npm run package:fast
npm run make:fast

Project Structure

zenside/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ main.ts              # Electron main process
β”‚   β”œβ”€β”€ renderer.tsx         # React entry point
β”‚   β”œβ”€β”€ App.tsx              # Main React component
β”‚   β”œβ”€β”€ preload.js           # IPC bridge
β”‚   β”œβ”€β”€ components/          # React components
β”‚   β”œβ”€β”€ services/            # Core services (filesystem, git, finance)
β”‚   β”œβ”€β”€ hooks/               # Custom React hooks
β”‚   β”œβ”€β”€ utils/               # Utility functions
β”‚   └── types/               # TypeScript type definitions
β”œβ”€β”€ assets/
β”‚   β”œβ”€β”€ zenside.icns         # App icon
β”‚   β”œβ”€β”€ note.png             # Menu bar icon
β”‚   └── favicon_io/          # Web icons
β”œβ”€β”€ docs/                    # Documentation
└── forge.config.js          # Electron Forge config

Configuration

Icon Files

  • App Icon: assets/zenside.icns - Main application icon (multiple resolutions)
  • Menu Bar: assets/note.png - Simple monochrome icon for macOS menu bar

Build Configuration

Edit forge.config.js to customize:

  • App icon
  • Bundle ID
  • Package settings
  • DMG appearance
  • Code signing (for distribution)

Contributing

Contributions are welcome! Please read CONTRIBUTING.md for guidelines on how to contribute to this project.

License

MIT License - see LICENSE file for details

Credits

Created with AI:

  • Built using Claude Code by Anthropic
  • AI-assisted development and architecture

Technology Stack:

Support


Made with ❀️ by Zenbytes

About

A dual-purpose macOS side panel combining note-taking (ZenNote) and personal finance tracking (ZenCash) into one elegant utility.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •