Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

オープン 初心者向け
  • 何か問題がありますか？
#195 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
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
平均マージ
3時間 39分
マージ済み PR（30日）
16

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

TheCodeHeist-Coder/Rexial のほかの issue

TheCodeHeist-Coder/Rexial の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。