Snowflake Desktop

🇷🇺 Русский | 🇺🇸 English

Менеджер книг для писателей. Создан для того, чтобы сделать вас исключительно продуктивными.

🌐 Официальный сайт | 📥 Скачать | 📖 Документация

Описание

Snowflake Desktop — это мощное десктопное приложение для писателей, которое помогает организовать процесс создания книг. Приложение предоставляет все необходимые инструменты для планирования сюжета, управления персонажами, отслеживания прогресса и создания детального лора вашего произведения.

Приложение построено на современных технологиях: Tauri для десктопной части с Rust бэкендом и Vue 3 + TypeScript для фронтенда, что обеспечивает высокую производительность и нативную интеграцию с операционной системой.

Особенности

📖 Управление проектами и книгами

• Создание и организация проектов
• Управление метаданными книг (жанр, статус, целевая аудитория)
• Локальное хранение данных с полной конфиденциальностью

🌍 Управление лором книги

• Персонажи: Создание детальных профилей с биографией, внешностью и ролью в сюжете
• Места: Описание локаций с атмосферой, особенностями и связями
• Вещи: Каталог предметов, артефактов и их истории
• События: Хронология важных событий с участниками и последствиями
• Интерактивная карта лора: Визуализация всех связей между элементами

✍️ Планирование сюжета

• Создание структуры книги по главам
• Управление сценами внутри глав
• Текстовый редактор с автосохранением каждые 30 секунд
• Отслеживание количества слов и статуса работы

💾 Экспорт и сохранение

• Автоматическое сохранение проекта
• Экспорт в формат DOCX с сохранением форматирования
• Возможность создания резервных копий

🔧 Дополнительные функции

• Полностью офлайн работа
• Оптимизация для больших проектов
• Интуитивный интерфейс для максимальной продуктивности
• Кроссплатформенность (Windows, Linux)

Установка

Скачать готовое приложение

Перейдите на страницу загрузок и скачайте версию для вашей операционной системы:

• Windows: .exe или .msi установщик
• Linux: .AppImage, .deb или .rpm пакет
• macOS: .dmg образ (планируется)

Системные требования

• Windows: Windows 10 или новее, 64-bit
• Linux: Ubuntu 20.04 или новее, 64-bit
• Память: 4 GB RAM
• Дисковое пространство: 100 MB свободного места

Как разрабатывать

Предварительные требования

• Node.js (версия 18 или выше)
• pnpm (рекомендуемый пакетный менеджер)
• Rust (для Tauri)

Настройка окружения

1. Клонируйте репозиторий:

   git clone https://github.com/ikloster03/snowflake-desktop.git
   cd snowflake-desktop

2. Установите зависимости:

   pnpm install

3. Настройте Git хуки:

   npx simple-git-hooks

   Примечание для Windows: Если возникает ошибка PowerShell, выполните:

   Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy RemoteSigned

Запуск в режиме разработки

# Веб-версия (для быстрой разработки UI)
pnpm dev:web

# Десктопная версия (Tauri)
pnpm dev:desktop

Сборка проекта

# Веб-версия
pnpm build:web

# Десктопная версия
pnpm build:desktop

Тестирование и проверка качества

# Проверка типов TypeScript
pnpm type-check

# Линтинг с улучшенным форматированием
pnpm lint:types

# Запуск тестов
pnpm test

# Тесты с покрытием кода
pnpm test:coverage

# Тесты с UI интерфейсом
pnpm test:ui

Работа с документацией

# Разработка документации
pnpm docs:dev

# Сборка документации
pnpm docs:build

# Предпросмотр документации
pnpm docs:preview

Git хуки

В проекте настроены автоматические проверки:

• commit-msg: Проверяет соответствие сообщений коммитов правилам Conventional Commits
• pre-push: Запускает проверку типов и тесты перед отправкой изменений

Архитектура проекта

snowflake-desktop/
├── src/                    # Исходный код фронтенда (Vue 3 + TypeScript)
│   ├── core/              # Основные модули
│   └── modules/           # Функциональные модули
├── src-tauri/             # Исходный код бэкенда (Rust)
├── docs/                  # Документация проекта
└── tests/                 # Тесты

Полезные ссылки

• 🌐 Официальный сайт
• 📥 Скачать приложение
• 📖 Руководство пользователя
• 🗺️ Дорожная карта
• 🐛 Сообщить об ошибке
• 💬 Обсуждения
• 📱 Telegram-группа

Лицензия

Этот проект распространяется под лицензией MIT. Подробности в файле LICENSE.

Статус разработки

Текущий статус: Разработка v1.0 (MVP завершен)

MVP версия приложения завершена и полностью функциональна. В настоящее время ведется активная разработка версии v1.0 с основным упором на:

• 🔧 Улучшение стабильности работы приложения
• 🐛 Исправление найденных ошибок
• ⚡ Оптимизация производительности
• 🔒 Повышение надежности сохранения данных
• 🎨 Улучшение пользовательского опыта

Все основные функции работают, однако некоторые возможности могут работать нестабильно. Если вы столкнулись с проблемами, пожалуйста, создавайте issues или сообщайте в нашей Telegram-группе.

---

Создано с ❤️ для писателей