Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Chiusa Adatta ai principianti
  • Qualcosa non va?
#195 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@divyanshAgarwal123 ci sta già lavorando.

Dal 24/10/2026.

  • #203 di @divyanshAgarwal123 — integrata

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
78/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
docker, node.js, redis, typescript
Ambito
documentation

Direzione di ricerca

Leggi setup.md, CONTRIBUTING.md, apps/ws-server/.env.example, package.json e .github/workflows/ci.yml; confronta i passaggi di configurazione con le connessioni Redis in apps/ws-server/src/redis.ts e il servizio in docker-compose.yml. Aggiorna le guide per includere Redis, il file di ambiente di ws-server e l’impostazione REDIS_HOST senza Docker, quindi allinea la versione di Node. Il lavoro è completo quando la configurazione documentata copre tutti i file .env richiesti ed evita ENOTFOUND redis.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
TypeScript
Stelle
21
Fork
7
Merge medio
4h 31m
PR unite (30g)
22

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di TheCodeHeist-Coder/Rexial

Tutte le issue di TheCodeHeist-Coder/Rexial

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.