teic/romajs Docker 镜像 - 轩辕镜像

RomaJS - roma.tei-c.org

镜像概述和主要用途

RomaJS是一款Web应用程序，用于创建和编辑ODD（One Document Does it All）文档，以自定义和生成文本编码倡议（TEI）的模式。该应用基于React/Redux开发，设计为可轻松编译并部署为静态站点，部分核心转换通过TEI维护的在线服务TEIGarage提供的API处理，TEI数据来源于TEI Vault。

核心功能和特性

• ODD文档处理：支持创建和编辑ODD文档，实现TEI模式的自定义配置
• TEI模式生成：根据自定义的ODD文档生成TEI模式文件
• 静态站点部署：可编译为静态资源，通过简单的Web服务器部署
• 外部服务集成：与TEIGarage API集成，处理核心转换逻辑
• TEI数据支持：使用TEI Vault提供的标准TEI数据资源

使用场景和适用范围

• TEI文档编码标准的定制与扩展
• 学术研究中特定文本类型的TEI模式生成
• 数字人文项目中TEI编码规范的个性化配置
• TEI相关教学与培训中的模式定制实践

使用方法和配置说明

部署方法

静态站点部署

1. 从发布页面下载最新构建版本
2. 通过简单的Web服务器提供静态站点服务
3. 配置URL路由重写规则（确保前端路由正常工作），例如Apache 2配置：

   RewriteEngine On
   
   RewriteCond %{REQUEST_FILENAME} !-f
   RewriteRule ^(.*)$ index.html [L,QSA]
   

Docker部署

可通过Docker镜像部署：teic/romajs

开发方法

环境准备

确保已安装node.js，然后执行：

bash
$ npm install --legacy-peer-deps

重要开发维护须知

RomaJS主要开发于2017-2018年，使用当时的技术栈。尽管编译后的工具稳定性有保障，但开发新功能或修复bug时可能面临依赖库过时问题。我们会修复明显的依赖问题，但通常会保持开发时可用的版本：

• 当前固定使用React 16和Webpack 3（参见#163）
• 特别注意：HTML组件使用早期版本的Material Components Web库（v 0.43.0），最新可用文档参见此处（Wayback Machine链接）

常用开发命令

• 测试：

  bash
  $ npm test
  

• 本地开发服务：

  bash
  $ npm start
  

• 构建静态资源：

  bash
  $ npm run build
  

配置说明

修改TEIGarage服务和TEI静态数据URL

• 方法1：编辑src/utils/urls.js文件后重新构建
• 方法2：通过Docker配置覆盖相关环境变量（具体变量需参考Docker镜像文档）