/Killara-docs

📜 Killara-docs

MIT LicenseMIT

My method is different. I do not rush into actual work. When I get an idea I start at once building it up in my imagination. I change the construction, make improvements, and operate the device entirely in my mind. ― Nikola Tesla

Killara-docs

Why Killara

Killara (Aboriginal word for "always there", pronounced like "Kuh laa ruh") is a distraction-free writing application designed by and for writers.

Alternatives applications

Name
Typora
Write
Caret
Notion
Mak
Inkdrop
Obsidian
Supernotes
Notability
Goodnotes
Dash
Lepton
Campfire

Things we use

Tech
Name Description
React Front-end JavaScript library
Tauri Framework for building desktop apps
Mantine React component library
Iconoir Icons library
TypeScript Strongly typed JavaScript
Sass CSS pre-processor
Dependabot Automated dependency updates
CODEOWNERS Automated code review request
Standard
Name Description
Blockprotocol Standard for building block-based interfaces
BEM Standard for naming CSS classes
Semantic Versioning Standard for Versioning
Antifragile Software Antifragile Software Manifesto
Changelog Notable changes for each version of a project

Versioning

  • Major (X.y.z) - Incremented for any backwards incompatible public API changes.
  • Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
  • Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.

User stories

  • As a writer, I want to create/read/update/delete notes, so that I can manage my notes.
  • As a writer, I want to create/read/update/delete folders, so that I can organize my notes.
  • As a writer, I want to copy/paste images into notes, so that I can update my notes.
  • As a writer, I want to format text, so that I can update my notes.