Skip to content

A local-first kanban app that writes Markdown files.

License

Notifications You must be signed in to change notification settings

cdevroe/signboard

Repository files navigation

Signboard

A local-first kanban desktop app built with HTML, CSS, and JavaScript. Signboard stores your lists as directories and cards as Markdown files on disk, so you own your data.

License: MIT GitHub issues GitHub pull requests Donate


✨ Highlights

  • 📂 Cards saved as Markdown files (portable & future-proof)
  • 🖌️ Custom color scheme per board
  • 🏷 Per-card labels with light/dark colors
  • 📅 Due dates
  • 🔎 Live search across
  • 🖥 Runs as a desktop app
  • 🪶 Minimal dependencies 😅, just plain JavaScript + Electron

🚀 Installation

  1. Go to the Releases page.
  2. On the latest release, download the correct file for your operating system.

Note: If you're moving from 0.4.0 to 0.5.0 you'll need to run the following command to convert all of your Markdown files to the new format. Or, just start with a new board.

npm run migrate:legacy-cards /Root/to/board


🛠 Development

git clone https://github.com/cdevroe/signboard.git
cd signboard
npm install
npm start

📦 Distribution Builds

macOS

# Current host architecture
npm run dist

# Specific macOS architectures
npm run dist:mac:arm64
npm run dist:mac:x64
npm run dist:mac:universal

# Build all macOS variants
npm run dist:mac:all

Windows (NSIS installer)

# Specific Windows architecture
npm run dist:win:x64
npm run dist:win:arm64

# Build both Windows architectures
npm run dist:win:all

Linux (AppImage, deb, rpm)

# Specific Linux architecture
npm run dist:linux:x64
npm run dist:linux:arm64

# Build both Linux architectures
npm run dist:linux:all

Build everything

npm run dist:all

Notes:

  • --publish never is used for local builds so these commands package artifacts without attempting to publish releases.
  • Copy .env-sample to .env and fill in your credentials before running signing/notarization builds.
  • macOS signing/notarization uses environment variables from .env (APPLE_ID, APPLE_APP_SPECIFIC_PASSWORD, and APPLE_TEAM_ID).
  • For the most reliable results, build each target on its native OS (or in CI runners for that OS/architecture).

🤝 Contributing

Contributions in all forms are welcome!

  • Report bugs: Open an Issue.
  • Suggest features: Open an Issue with the enhancement label.
  • Submit fixes or features: Fork the repo, make your changes, and open a Pull Request.

Contribution Guidelines

  • Keep PRs focused: one change per PR makes reviews faster.
  • Follow existing code style where possible (or, please, suggest new code styles!)
  • Be respectful and constructive in discussions.

💖 Support the Project

If you find Signboard useful and want to support development, you can donate here:

👉 https://cdevroe.com/donate

Thank you!


📜 License

MIT © 2025 Colin Devroe - https://cdevroe.com

Third-Party Notices

My thanks to John Gruber for creating Markdown and to Steph Ango, CEO of Obsidian, for his File over app philosophy.

Signboard includes static versions of the following open source libraries:

About

A local-first kanban app that writes Markdown files.

Resources

License

Stars

Watchers

Forks

Packages

No packages published