https://github.com/cdevroe/signboard
A local-first kanban app that writes Markdown files.
https://github.com/cdevroe/signboard
Last synced: about 1 month ago
JSON representation
A local-first kanban app that writes Markdown files.
- Host: GitHub
- URL: https://github.com/cdevroe/signboard
- Owner: cdevroe
- License: mit
- Created: 2025-09-09T13:52:23.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-10-08T13:27:46.000Z (6 months ago)
- Last Synced: 2025-12-25T17:17:55.087Z (3 months ago)
- Language: JavaScript
- Size: 340 KB
- Stars: 25
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# 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)
[](../../issues)
[](../../pulls)
[](https://cdevroe.com/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](../../releases).
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
```bash
git clone https://github.com/cdevroe/signboard.git
cd signboard
npm install
npm start
```
---
## ðĶ Distribution Builds
### macOS
```bash
# 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)
```bash
# 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)
```bash
# Specific Linux architecture
npm run dist:linux:x64
npm run dist:linux:arm64
# Build both Linux architectures
npm run dist:linux:all
```
### Build everything
```bash
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](../../issues).
- **Suggest features**: Open an [Issue](../../issues) with the `enhancement` label.
- **Submit fixes or features**: Fork the repo, make your changes, and open a [Pull Request](../../pulls).
### 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](https://cdevroe.com/donate)
Thank you!
---
## ð License
[MIT](./LICENSE) ÂĐ 2025 Colin Devroe - https://cdevroe.com
# Third-Party Notices
My thanks to [John Gruber](https://daringfireball.net/) for creating [Markdown](https://daringfireball.net/projects/markdown/) and to [Steph Ango](https://stephango.com/), CEO of [Obsidian](https://obsidian.md/), for his [File over app philosophy](https://stephango.com/file-over-app).
Signboard includes static versions of the following open source libraries:
- [Marked](https://github.com/markedjs/marked) â [MIT License](https://github.com/markedjs/marked/blob/master/LICENSE.md)
- [Turndown](https://github.com/mixmark-io/turndown) â [MIT License](https://github.com/mixmark-io/turndown/blob/master/LICENSE)
- [OverType](https://github.com/panphora/overtype) - [MIT License](https://github.com/panphora/overtype/blob/main/LICENSE)
- [SortableJS](https://github.com/SortableJS/Sortable) â [MIT License](https://github.com/SortableJS/Sortable/blob/master/LICENSE)
- [Feather Icons](https://github.com/feathericons/feather) â [MIT License](https://github.com/feathericons/feather/blob/master/LICENSE)
- [fDatepicker](https://github.com/liedekef/fdatepicker) â [MIT License](https://github.com/liedekef/fdatepicker/blob/master/LICENSE.md)