Kivixa

A Modern Cross-Platform Notes & Canvas Application

Seamlessly blend notes, sketches, and creativity across all your devices

Features • Getting Started • Contributing • Documentation

---

Features

Notes & Documents

• Rich Markdown Editor - Create beautiful formatted documents with AppFlowy Editor
  • Text formatting (bold, italic, underline, strikethrough)
  • Block formatting (lists, checkboxes, quotes, code blocks)
  • Hyperlink support
  • Real-time autosave
• Floating Text Boxes - Add moveable, resizable text boxes anywhere on the canvas
• File Organization - Intuitive folder system with move, rename, and delete operations
• Multiple Formats - Support for .kvx (native), .md (markdown), and PDF files

Digital Canvas

• Advanced Drawing Tools
  • Pen with pressure sensitivity
  • Highlighter for emphasis
  • Laser pointer for presentations
  • Eraser with multiple modes
  • Shape tools and selection
• Professional Canvas Features
  • Infinite canvas with smooth pan & zoom
  • Layer support for complex artwork
  • Background customization (colors, patterns, images)
  • Grid and snap-to-grid options
  • Transform tools (rotate, scale, move)

PDF Integration

• Import and annotate PDF documents
• Export notes as PDFs
• Maintain annotations across devices
• High-quality rendering

Productivity

• Smart Autosave - Never lose your work with automatic saving
• File Manager - Powerful organization with search and filtering
• Recent Files - Quick access to your latest work
• Cross-Platform Sync - Work seamlessly across devices
• Keyboard Shortcuts - Boost productivity with keybindings

Customization

• Dynamic Theming - Material You dynamic color support
• Dark & Light Modes - Easy on the eyes, any time of day
• Custom Fonts - Choose from Google Fonts library
• Flexible UI - Customize toolbars and layouts

Privacy & Security

• Local-First - Your data stays on your device
• Secure Storage - Encrypted sensitive data with flutter_secure_storage
• No Cloud Dependencies - Works completely offline
• Export Control - You own your data, export anytime

---

Getting Started

Prerequisites

• Flutter 3.35.0 or higher
• Dart 3.9.0 or higher
• Platform-specific requirements:
  • Windows: Visual Studio 2022 with C++ desktop development
  • macOS: Xcode 15+
  • Linux: Standard build tools (clang, cmake, ninja-build)
  • Android: Android Studio / Android SDK
  • iOS: Xcode 15+ and CocoaPods

Installation

1. Clone the repository

   git clone https://github.com/990aa/kivixa.git
   cd kivixa

2. Install dependencies

   flutter pub get

3. Run the app

   # For desktop (Windows/macOS/Linux)
   flutter run -d windows  # or macos, linux
   
   # For mobile (Android/iOS)
   flutter run -d android  # or ios
   
   # Let Flutter choose the best available device
   flutter run

Build for Production

# Android APK
flutter build apk --release

# Android App Bundle
flutter build appbundle --release

# Windows
flutter build windows --release

# macOS
flutter build macos --release

# Linux
flutter build linux --release

# iOS (requires macOS)
flutter build ios --release

---

Built With

Core Technologies

• Flutter - Cross-platform UI framework
• Dart - Programming language
• AppFlowy Editor - Rich text editing
• Perfect Freehand - Smooth drawing strokes

Key Dependencies

• UI/UX: material_symbols_icons, dynamic_color, animations
• Drawing: perfect_freehand, vector_math, flutter_quill
• File Management: path_provider, file_picker, share_plus
• PDF: pdf, pdfrx, printing
• Storage: shared_preferences, flutter_secure_storage
• Utilities: go_router, url_launcher, screenshot

Full dependency list available in pubspec

---

Platform Support

Platform	Status	Notes
Windows	Stable	Fully tested and optimized
macOS	Stable	Requires macOS 10.15+
Linux	Stable	Tested on Ubuntu 20.04+
Android	Stable	Android 7.0 (API 24)+
iOS	Stable	iOS 12.0+
Web	Experimental	Limited features

---

Documentations

• Changelog - Version history and release notes
• Contributing Guidelines - How to contribute to the project
• Code of Conduct - Community standards and expectations
• License - Legal information and usage rights

Issue Tracking

• Bug Report - Report bugs and issues
• Feature Request - Suggest new features

---

Contributing

Open to contributions from the community! Whether you're fixing bugs, adding features, or improving documentation, your help is appreciated.

How to Contribute

1. Fork the repository
2. Create a feature branch

   git checkout -b feature/amazing-feature

3. Make your changes and commit

   git commit -m 'Add amazing feature'

4. Push to your branch

   git push origin feature/amazing-feature

5. Open a Pull Request

Development Guidelines

• Follow the existing code style and conventions
• Write meaningful commit messages
• Add tests for new features
• Update documentation as needed
• Test on multiple platforms when possible

For detailed guidelines, see CONTRIBUTING.

To report a new issue, use Bug Report Template.

---

Contact & Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Repository: kivixa

---

⭐ Star this repository if you find it helpful!