Техническая документация

Документация разработчика

public — веб-корень; src содержит код, а storage — закрытую базу SQLite.

Документация разработчика

Продукт и обязательные решения

That's My Dash 0.8.1 — персональная веб-страница для Ð½ÐµÑÐºÐ¾Ð»ÑŒÐºÐ¸Ñ Ð¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ñ‚ÐµÐ»ÐµÐ¹. Требуются PHP 8.2+, SQLite и HTTPS. MySQL, командная строка и ручной импорт базы не должны становиться требованиями. Существующие базы расширяются добавочно; config.php и весь каталог storage ÑÐ¾Ñ Ñ€Ð°Ð½ÑÑŽÑ‚ÑÑ.

Интерфейс поддерживает восемь языков, английский является Ñ‚ÐµÑ Ð½Ð¸Ñ‡ÐµÑÐºÐ¸Ð¼ резервным языком.

АрÑ

итектура

  • public — предполагаемый веб-корень.
  • src содержит обработку запросов, базу, безопасность и HTTP-вызовы.
  • views содержит шаблоны и не изменяет данные.
  • storage содержит SQLite, кэш и локальные языковые файлы и остается закрытым.
  • public/index.php выполняет действия, загружает контекст и представление.

Правила кода и данныÑ

  • Используйте строгие типы и подготовленные запросы PDO.
  • При изменении личныÑ
  • Ð´Ð°Ð½Ð½Ñ‹Ñ ÑƒÑ‡Ð¸Ñ‚Ñ‹Ð²Ð°Ð¹Ñ‚Ðµ id текущего пользователя.

  • Экранируйте вывод и не разрешайте пользовательский HTML.
  • Все записи используют POST, CSRF, проверку и контроль владельца.
  • Миграции добавочные, идемпотентные и обратно совместимые.
  • Основное редактирование работает без JavaScript.

Безопасность, доступность и языки

Внешние запросы используют только HTTPS, блокируют частные сети и ограничивают перенаправления, время и размер. Google Календарь необязателен. Цель — WCAG 2.2 AA: семантический HTML, клавиатура, видимый фокус, масштабирование, уменьшение движения и высокий контраст. Языки Ð½Ð°Ñ Ð¾Ð´ÑÑ‚ÑÑ в languages, локальные изменения — в storage/languages. :place и {query} не переводятся.

Контроль выпуска

Запускайте проверки PHP, JavaScript, JSON и языков. Тестируйте чистую установку и обновление, телефон и компьютер, светлую и темную темы, роли, разделение пользователей, клавиатуру, экранный диктор и масштаб. Обновляйте VERSION, README, CHANGELOG, PROJECT_STATUS и аудит.