JKI Project Analytics & UI
Репозиторий содержит архитектурную документацию, аналитические материалы и исходный код фронтенд-составляющей проекта JKI. Проект организован по методологии Docs-as-Code, где проектные артефакты и схемы хранятся непосредственно в репозитории вместе с кодовой базой.
📁 Структура проекта
-
jki/ux/— материалы проектирования пользовательского опыта (UX), карты экранов и логика взаимодействия. -
jki/diagrams/— архитектурные диаграммы, схемы потоков данных (DFD) и Use Case диаграммы. -
jki/docs/— текстовая документация, бизнес-требования, технические спецификации и пользовательские сценарии. -
jki/index.htm— главная веб-страница (точка входа в интерфейс приложения). -
jki/style.css— каскадные таблицы стилей (CSS) для оформления UI-компонентов. -
jki/script.js— клиентская логика и интерактивные элементы интерфейса на JavaScript. -
jki/node.js— серверная часть проекта / конфигурационные скрипты окружения на Node.js.
🚀 Быстрый запуск
Требования
Для работы с серверными компонентами и зависимостями проекта вам понадобится:
- Node.js (версии 16.x или выше)
Запуск фронтенда
Для просмотра интерфейса достаточно открыть файл jki/index.htm в любом современном веб-браузере.
Запуск серверной части
- Перейдите в корневую директорию проекта.
- Запустите серверный скрипт с помощью Node.js:
node jki/node.js
🛠 ️ Стек технологий
- Frontend: HTML5, CSS3, JavaScript (Vanilla JS)
- Backend / Tooling: Node.js
- Documentation: Markdown, Схемы и диаграммы (UX/Diagrams)
📝 Разработка и документирование
При внесении изменений в проект придерживайтесь следующих правил:
-
Код интерфейса: Стили описываются строго в
style.css, логика — вscript.js. Не используйте инлайновые стили и скрипты внутриindex.htm. -
Документация: Любое изменение функционала должно сопровождаться обновлением соответствующих спецификаций в папке
jki/docs/и диаграмм вjki/diagrams/.