Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

Redis is required to run the app but is in neither setup guide

已关闭 适合新手
  • 哪里不对？
#195 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

@divyanshAgarwal123 已经在做这个了。

开始于 2026年10月24日。

  • #203 来自 @divyanshAgarwal123 —— 已合并

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
78/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
docker, node.js, redis, typescript
领域
documentation

调研方向

阅读 setup.md、CONTRIBUTING.md、apps/ws-server/.env.example、package.json 和 .github/workflows/ci.yml；将设置步骤与 apps/ws-server/src/redis.ts 中的 Redis 连接以及 docker-compose.yml 中的服务进行比较。更新指南，涵盖 Redis、ws-server 环境文件以及不使用 Docker 时的 REDIS_HOST 设置，然后统一 Node 版本。完成标准：文档中的设置涵盖所有必需的 .env 文件，并避免出现 ENOTFOUND redis。

由索引模型根据 Issue 内容生成。

描述

documentation good first issue help wanted

Neither setup.md nor CONTRIBUTING.md mentions Redis:

$ grep -ic redis setup.md CONTRIBUTING.md
setup.md:0
CONTRIBUTING.md:0

But it is load-bearing. apps/ws-server/src/redis.ts opens three connections at import time — pub, sub and cache — defaulting to host redis, a name that only resolves inside Docker. docker-compose.yml runs a redis:7-alpine service and ws-server depends_on it with condition: service_healthy.

Why it matters

setup.md has a section on running without Docker, and CONTRIBUTING.md step 10 says to run pnpm run dev. Either path gives a wall of:

Redis Pub Error: ENOTFOUND redis

with nothing in the docs explaining what Redis is doing here, that it needs to be installed, or that a non-Docker run needs REDIS_HOST=localhost. A contributor's first impression is a broken repo.

A second gap in the same file

setup.md tells you to create a .env for packages/db, apps/http-server and apps/genAI — but never for apps/ws-server, which now needs one. CONTRIBUTING.md already covers it properly, including the warning that JWT_SECRET must match http-server and what happens when it does not. setup.md just needs to match its sibling.

While you are in there

Three files give three different answers to "what Node version?":
setup.md line 24 Node.js (>= 20)
package.json "node": ">=18"
.github/workflows/ci.yml node-version: 22

Worth settling on one and making them agree.

What a fix looks like
  • Add Redis to the prerequisites, with a one-line note on what it is used for
  • Add the apps/ws-server/.env step, pointing at apps/ws-server/.env.example
  • Note that running outside Docker needs REDIS_HOST=localhost
  • Reconcile the Node version
Definition of done
  • Following setup.md from a clean clone gets you a running app with no ENOTFOUND redis
  • Every .env the app needs is listed
  • The Node requirement is stated once and consistently

Good first issue: documentation only, but the best way to find the gaps is to follow your own guide on a clean checkout and write down everything that goes wrong.

主要语言
TypeScript
星标
21
派生
7
平均合并
5 小时 43 分钟
30 天内合并 PR
30

环境准备

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

TheCodeHeist-Coder/Rexial 的其他 Issue

查看 TheCodeHeist-Coder/Rexial 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。