Rating Tracker

一个用于获取和提供***财务及ESG评级的Web服务。

核心功能与特性

带排序和筛选功能的***列表

***及其信息以分页表格形式展示，支持通过多种可用属性进行全面深入的排序和筛选。

!Rating Tracker***列表

从多个提供商自动和定时获取数据

通过在“添加***”对话框中提供来自*** Finance、Morningstar、MarketScreener、MSCI、LSEG Data & Analytics、Standard & Poor’s和Sustainalytics的标识符，Rating Tracker可以自动获取财务数据以及财务和ESG评级。使用的标识符可在提供商的URL中找到，如下例所示：

• : [***]AAPL（此代码也是URL、数据库表等中的主要标识符。如果某没有*** Finance代码，可使用以下划线_为前缀的任意代码，表示无需为此获取价格。）
• Morningstar: [***]0P000000GY&LanguageId=it-IT&SecurityToken=0P000000GY]3]0]E0WWE$$ALL
• MarketScreener: [***]APPLE-INC-4849
• MSCI: [***]IID000000002157615
• LSEG Data & Analytics: [***]AAPL.O（另见Refinitiv识别码）
• Standard & Poor’s: [***]4004205
• Sustainalytics: [***]apple-inc/***

可通过在环境变量中提供Cron风格的说明符来安排数据获取时间。详情见下文。

***Logo

提供***的ISIN后，系统会自动从TradeRepublic经纪商获取并缓存其Logo。

评级分数

的获取评级通过所有评级的平均值聚合为财务分数和ESG分数，平均水平得分为0，所有基础评级均为完美分数的***得分为100。

财务分数和ESG分数通过两者的调和平均数计算总分，因此***必须在财务和ESG评级中均表现良好才能获得较高总分。

观察列表（Watchlists）

用户可将关注的组织到观察列表中。系统默认提供“收藏”观察列表，可通过点击的星形图标轻松维护。

用户可订阅观察列表，以便在***评级更新时接收通知。

***组合（Portfolios）

可将按特定货币金额加权的聚合到组合中。系统可显示组合的平均评级分数，以及的地区、行业板块、公司规模和风格分布。

!Rating Tracker***组合

***组合构建器

该工具可基于地区、板块和其他因素的偏好比例，提供组合中的最优权重。

可来自现有组合、观察列表或手动搜索：

!Rating Tracker组合构建器 – 选择

然后可设置地区、板块、规模和风格的约束条件，以及组合货币和其他设置，如总金额、单只***最低货币金额或比例分配算法：

!Rating Tracker组合构建器 – 配置组合

生成的***分布以类直方图图表展示，并突出显示目标百分比与实际百分比之间的差异：

!Rating Tracker***组合构建器 – 查看结果

将加权保存到新组合或现有***组合的对话框会清晰列出所有待执行更新以及向服务器传输的进度：

!Rating Tracker***组合构建器 – 保存结果

用户管理

Rating Tracker支持多用户，用户可通过WebAuthn自助注册，管理员可通过“用户管理”Web界面授予用户细粒度访问权限后，用户即可访问应用。

!Rating Tracker用户管理

通过Signal发送通知消息

基于用户的访问权限，用户可通过提供能够接收即时通讯工具Signal消息的电话号码，订阅***评级更新、获取错误报告或新用户注册通知。

!Rating Tracker个人资料设置 !Rating Tracker Signal通知

带截图的错误报告

当获取失败时，系统会存储尝试获取页面的截图，并向订阅错误报告的维护者发送截图链接，以便他们分析和解决问题。

结构化日志

JSON格式日志输出到stdout和轮转日志文件。为提高可读性，可使用控制台格式化工具或单独的日志查看服务（如Dozzle）。容器中预装了格式化工具pino-pretty，可通过修改容器命令管道化服务器输出来使用：node ./server.mjs | pino-pretty。

也可通过在shell中为pino-pretty设置别名，使用现有Rating Tracker容器格式化日志文件：

shell
# ~/.zshrc
alias pino-pretty="docker exec -i \$(docker compose -f <docker compose文件路径> ps -q <容器名称>) pino-pretty -c

# 查看（并跟踪）日志文件：
tail -n +1 -f <...>/rating-tracker.log | pino-pretty | less

…以及更多即将推出的功能！

计划功能记录于此处。如您认为缺少某些功能，欢迎提出功能请求！

演示

Rating Tracker的公开实例可在[***]

部署

Rating Tracker设计为使用Docker或类似容器平台部署。

前提条件

运行Rating Tracker需具备以下服务：

• PostgreSQL：存储***和用户相关信息
• Signal Messenger REST API：通过Signal即时通讯工具发送通知
• nginx或其他反向代理：提供SSL加密（大多数WebAuthn客户端要求）

使用Docker Compose的最小示例配置

Docker Compose是运行Rating Tracker及其依赖服务的推荐方式。以下配置文件展示了示例性设置。

yml
version: "3.8"

services:
  postgres:
    image: postgres:alpine
    ports:
      - "127.0.0.1:5432:5432"
    environment:
      POSTGRES_DB: "rating-tracker"
      POSTGRES_USER: "rating-tracker"
      POSTGRES_PASSWORD: "********"
      PGDATA: /var/lib/postgresql/data
    volumes:
      - ./postgresql/data:/var/lib/postgresql/data
    shm_size: '256mb'

  signal:
    image: bbernhard/signal-cli-rest-api
    environment:
      MODE: json-rpc
    ports:
      - "127.0.0.1:8080:8080"
    volumes:
      - ./signal-cli:/home/.local/share/signal-cli

  rating-tracker:
    image: marvinruder/rating-tracker
    tty: true # 允许stdout彩色输出
    init: true # 支持优雅关闭
    environment:
      PORT: 21076
      DOMAIN: "example.com"
      SUBDOMAIN: "ratingtracker"
      TRUSTWORTHY_PROXY_COUNT: 1
      LOG_FILE: "/app/logs/rating-tracker-log-(DATE).log" # (DATE)会被当前日期替换以支持日志轮转
      DATABASE_URL: "postgresql://rating-tracker:********@postgres:5432/rating-tracker?schema=rating-tracker"
      MAX_FETCH_CONCURRENCY: 4
      AUTO_FETCH_SCHEDULE: "0 0 0 * * *" # 此格式包含秒
      SIGNAL_URL: "[***]"
      SIGNAL_SENDER: "+12345678900"
    ports:
      - "127.0.0.1:443:21076" # 如果nginx在同一Docker Compose配置中运行，则不需要
    volumes:
      - ./logs/rating-tracker:/app/logs
    depends_on:
      - postgres
      - signal
    restart: unless-stopped

端口绑定是可选的，但有助于从主机连接到服务，例如用于调试目的。

设置步骤

初始化数据库设置

Rating Tracker使用Prisma与PostgreSQL数据库交互。首次启动时，Prisma Migrate会自动创建所需的表和索引。

创建Signal账户

在Signal REST API容器中运行shell，并按照这份优秀文档操作。

配置Web服务器作为反向代理

使用SSL设置NGINX作为Web服务器后，可使用以下虚拟主机配置运行反向代理：

nginx
resolver 127.0.0.11 valid=15s; # Docker的DNS解析器，用于解析Docker Compose容器名称

location / {
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    set $target_host rating-tracker; # 如果nginx在Docker Compose配置外部运行，此处使用127.0.0.1
    proxy_pass [***]
}

初始管理员注册

设置Rating Tracker实例后，导航至其URL并注册，创建WebAuthn凭证。首个注册用户将自动获得最高访问权限。注册后，即可使用凭证登录。

支持的环境变量

粗体变量为必填项。

API参考

任何Rating Tracker实例的API均提供自文档，其OpenAPI Web界面托管于/api-docs。完整OpenAPI规范文档可从/api-spec/v3.1下载。

开发

创建开发环境

可使用仓库中包含的VS Code开发容器配置快速创建开发Rating Tracker及其依赖服务所需的所有工具环境。package.json的scripts部分提供了有用命令：

• 克隆仓库并在Visual Studio Code中打开。出现提示时，选择“在容器中重新打开”。这将创建包含所有必需工具、推荐扩展和依赖项的Docker容器。
• 检查环境。需事先向Vite提供SSL证书，启动服务器前需创建Signal账户（详见设置步骤）。
• 运行yarn workspace @rating-tracker/backend prisma:migrate:deploy初始化PostgreSQL数据库。
• 运行yarn dev启动后端服务器和Vite前端开发服务器。

开发容器配置中未包含的环境变量可在.env文件中定义：