Создание инженерного веб-портала для совместных исследований и обмена данными

4. Коммуникация и уведомления в реальном времени

Публичные и частные дискуссионные форумы, прямые сообщения и каналы активности — все это может быть основано на интеграции WebSockets от Directus. Когда пользователь добавляет комментарий или загружает файл данных, Directus может транслировать событие всем подключенным клиентам. Фронтенд может затем обновлять пользовательский интерфейс в режиме реального времени без опроса. Уведомления (электронная почта или приложение) могут быть запущены с помощью Directus Hooks. Например, крюк на действии «файл: создать» может отправить электронное письмо всем членам проекта, если файл превышает определенный размер или принадлежит критическому эксперименту.

5. расширенный поиск и обнаружение данных

Портал полезен только в том случае, если пользователи могут быстро найти информацию. Directus поддерживает полнотекстовый поиск по строковым полям из коробки. Для более сложных потребностей вы можете интегрировать Elasticsearch или Meilisearch и индексировать соответствующие поля из ваших коллекций Directus. Метаданные, такие как код проекта, используемый инструмент и экспериментальные условия, должны храниться в виде структурированных полей, чтобы включить граненую фильтрацию. Кроме того, вы можете создавать пользовательские конечные точки поиска с помощью системы расширения Directus, которая объединяет несколько коллекций (файлы, проекты, дискуссии) в единый набор результатов.

6. API-доступ для автоматизации

Инженеры и исследователи захотят программно загружать данные с лабораторных инструментов, запрашивать наборы данных из сценариев или автоматизировать генерацию отчетов. Именно это позволяют самодокументирующиеся REST и GraphQL API Directus. Вы можете генерировать токен API для каждого пользователя или машины, с разрешениями, ограниченными конкретными коллекциями и операциями. Это позволяет записать проглатывание температурных журналов с удаленного датчика или потянуть последние результаты стресс-теста в ноутбук Jupyter.

Планирование вашего инженерного портала

Прыжок прямо в разработку без четкого плана приводит к появлению проблем с адаптацией функций и пользователей. Вот критические шаги планирования.

Определение цели и личности пользователя

Кто будет использовать портал? Типичные персоны включают:

• Основные исследователи (PIs) — курируют проекты, одобряют выпуски данных, управляют бюджетами.
• Выпускники и постдоки — загружают экспериментальные данные, анализируют результаты, сотрудничают по бумагам.
• Партнеры по отрасли — доступ к общим наборам данных в рамках нераскрытия, внесение требований.
• Техники лаборатории — управляют бронированием оборудования, записывают данные калибровки.
• IT администраторы — поддерживают платформу, управляют резервными копиями, обеспечивают соблюдение политик безопасности.

Для каждого человека, определите задачи, которые он должен выполнить, и данные, к которым он должен получить доступ. Это приводит к ролевой схеме разрешения в Directus.

Моделирование данных: сердце портала

Directus отражает схему базы данных, поэтому необходимо тщательное моделирование данных. Используйте реляционный дизайн. Общие коллекции для инженерного портала включают:

• проекты — с полями: title, description, PI (ссылка на пользователей), start date, end date, status, funding source.
• наборы данных — с полями: проект (ссылка), имя, описание, файл (файл Directus), experimental parameters (JSON), created by, created at.
• задачи — с полями: проект, цессионарий, due date, приоритет, завершенные, примечания.
• обсуждения — с полями: проект, название, содержание (богатый текст), created by, locked (bool).
• Публикации — с полями: проект, название, авторы, doi, pdf attachment, абстракция.

Используйте отношения Directus Many-to-Many для пользователей в нескольких проектах. Добавьте M2A (Many-to-Any) если вам нужно прикрепить комментарии или теги к нескольким типам коллекций.

Выберите стратегию Frontend

Directus без головы, то есть вам нужен отдельный интерфейс.

• Одностраничное приложение (SPA) с использованием React, Vue или Angular — лучше всего подходит для динамического взаимодействия в реальном времени.
• Обслуживание на стороне сервера (SSR) с помощью Nuxt.js (Vue) или Next.js (React) — лучшее SEO для общедоступных частей портала.
• Генератор статических сайтов — подходит, если большинство контента является общедоступным и редко изменяется (например, документация).

Какой бы вариант вы ни выбрали, используйте JavaScript SDK Directus (] для упрощения вызовов API. Для аутентификации реализуйте потоки токенов Directus или OAuth2.

Шаги реализации с Directus

Следуйте этим шагам, чтобы перейти от планирования к рабочему порталу.

Шаг 1: Настройка Directus

Разверните Directus на своей инфраструктуре. Вы можете использовать Docker Compose для быстрого старта:

version: '3'
services:
 directus:
 image: directus/directus:latest
 ports:
 - "8055:8055"
 environment:
 DB_CLIENT: 'pg'
 DB_HOST: 'postgres'
 DB_PORT: 5432
 DB_DATABASE: 'directus'
 DB_USER: 'directus'
 DB_PASSWORD: 'password'
 ADMIN_EMAIL: '[email protected]'
 ADMIN_PASSWORD: 'securepassword'
 volumes:
 - ./uploads:/directus/uploads
 - ./extensions:/directus/extensions

Настройка хранилища (локального или S3), службы электронной почты для уведомлений и кэширования по мере необходимости.

Шаг 2: Разработка схемы базы данных

Используя Data Studio, создайте коллекции, определенные на этапе планирования. Установите соответствующие типы полей: текст, JSON, реляционные, дата-время и т. Д. Включите переключение Пересмотры для коллекций, где важны аудиторские следы (проекты, задачи, публикации. Для наборы данных , используйте тип поля файла , чтобы напрямую связать загруженные файлы.

Настройка Отношения в Data Studio.Например, проект может иметь множество задач (один ко многим), а пользователь может принадлежать ко многим проектам (многие ко многим).

Шаг 3: Выполнение разрешений

Перейдите в Настройки → Роли и Разрешения. Создайте роли для каждого персонажа: Администратор , PI , Исследователь , Партнер отрасли , Вивер. Для каждой коллекции определите фильтры уровня строк. Например:

• Исследователь: может создавать, читать, обновлять свои собственные наборы данных, но только читать проекты, членами которых они являются.
• Роль отраслевого партнера: может читать наборы данных и проекты, помеченные как «совместно с партнером», но не может создавать или редактировать.
• Виавер Роль: Может читать только общественные проекты и публикации.

Используйте пресеты Directus для автоматического установки значений поля по умолчанию, когда пользователь создает новую запись (например, автоматически установит на текущего пользователя).

import { createDirectus, subscribe } from '@directus/sdk';
const directus = createDirectus('https://portal.engr.univ.edu');
const subscription = await directus.subscribe('projects');
subscription.onEvent((event) => {
 // event.type: 'create', 'update', 'delete'
 // event.key: primary key
 // event.data: the changed object (if update/create)
 // update reactive state
});