Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

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

Closed Beginner friendly
  • Is something wrong?
#195 2 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

@divyanshAgarwal123 is already working on this.

Since Oct 24, 2026.

  • #203 by @divyanshAgarwal123 — merged

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
docker, node.js, redis, typescript
Domain
documentation

Research direction

Read setup.md, CONTRIBUTING.md, apps/ws-server/.env.example, package.json and .github/workflows/ci.yml; compare the setup steps with the Redis connections in apps/ws-server/src/redis.ts and the service in docker-compose.yml. Update the guides to cover Redis, the ws-server environment file and the non-Docker REDIS_HOST setting, then reconcile the Node version. Done when the documented setup covers every required .env and avoids ENOTFOUND redis.

Written by the indexing model from the issue text.

Description

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.

Dominant language
TypeScript
Stars
21
Forks
7
Avg merge
4h 31m
Merged PRs (30d)
22

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from TheCodeHeist-Coder/Rexial

All issues in TheCodeHeist-Coder/Rexial

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.