Skip to content

README.md

Latest commit

 

History

History
129 lines (95 loc) · 5.2 KB

README.md

File metadata and controls

129 lines (95 loc) · 5.2 KB

📝 NNotes

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

Java JavaFX Maven License

✨ Возможности

  • 📄 Создание заметок: Пишите и сохраняйте заметки с пользовательскими именами
  • 📂 Управление файлами: Открывайте, редактируйте и удаляйте существующие заметки
  • 💾 Автосохранение: Автоматическое отслеживание даты для всех заметок
  • 📋 Список заметок: Просматривайте все ваши заметки в организованном списке
  • 🎨 Чистый интерфейс: Современный интерфейс с разделенными панелями для оптимального рабочего процесса
  • 💻 Кроссплатформенность: Работает на Windows, macOS и Linux

🚀 Начало работы

Требования

  • Java 21 или выше
  • Maven 3.6+ (или используйте включенную оболочку Maven)

📦 Установка

  1. Клонировать репозиторий

    git clone https://github.com/yourusername/NNotes.git
cd NNotes

  2. Собрать проект

    ./mvnw clean compile

  3. Запустить приложение

    ./mvnw clean javafx:run

🔧 Разработка

Доступные команды:

# Компилировать проект
./mvnw clean compile

# Запустить приложение
./mvnw clean javafx:run

# Запустить тесты
./mvnw test

# Упаковать приложение
./mvnw clean package

🎯 Как использовать

  1. Создание заметки

    • Введите имя для вашей заметки в поле "NAME"
    • Напишите ваш контент в текстовой области
    • Нажмите "Save" для сохранения заметки

  2. Открытие заметки

    • Нажмите "Open" для просмотра сохраненных заметок
    • Выберите заметку из диалога выбора файла
    • Содержимое заметки загрузится в редактор

  3. Управление заметками

    • Просматривайте все заметки в левой панели
    • Используйте "Clear" для очистки редактора
    • Используйте "Delete" для удаления текущей загруженной заметки

🏗️ Архитектура

src/
├── main/
│   ├── java/com/example/demo2/
│   │   ├── HelloApplication.java    # Главная точка входа приложения
│   │   ├── HelloController.java     # Логика контроллера UI
│   │   ├── Note.java               # Модель данных заметки
│   │   └── module-info.java        # Конфигурация Java модуля
│   └── resources/com/example/demo2/
│       └── hello-view.fxml         # Определение макета UI

Технический стек:

  • Фронтенд: JavaFX 21 с FXML
  • Бэкенд: Java 21
  • Система сборки: Maven
  • Хранение данных: JSON файлы (FastJSON)
  • Тестирование: JUnit 5

📂 Хранение данных

Заметки сохраняются как JSON файлы в директории NNotes/:

{
  "name": "Моя заметка",
  "ntext": "Содержимое заметки здесь...",
  "dateOfNote": "Mon Sep 09 10:36:15 2025"
}

🤝 Участие в разработке

  1. Сделайте форк репозитория
  2. Создайте ветку для новой функции (git checkout -b feature/AmazingFeature)
  3. Зафиксируйте ваши изменения (git commit -m 'Add some AmazingFeature')
  4. Отправьте ветку (git push origin feature/AmazingFeature)
  5. Откройте Pull Request

📄 Лицензия

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

👨‍💻 Автор

Создано 80n

⭐ Поставьте звезду этому проекту, если он вам полезен!