unicodeveloper / unicodeveloper/globalthreatmap

Incorrect installation commands in README

Open Beginner friendly
#31 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
1.8k
Forks
300
No merged PRs in 30d

Description

Problem

The README list npm commands while the project exclusively uses pnpm:

npm install
npm run dev

Running npm install on this project:

  • ignores the existing pnpm-lock.yaml
  • may install dependency versions different from those tested
  • produces a next: not found error on launch because node_modules is incorrectly structured

Evidence

The project enforces pnpm in three places:

  • pnpm-lock.yaml present at the root
  • Dockerfile: RUN corepack enable && corepack prepare pnpm@latest --activate
  • compose.yaml: CMD ["pnpm", "start"]

Fix to apply

pnpm install
pnpm dev

Add pnpm to prerequisites:

- pnpm (npm install -g pnpm or corepack enable)

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Update the README installation and development commands shown in the issue, and add pnpm to the prerequisites. Use pnpm-lock.yaml, Dockerfile, and compose.yaml as references for the project's package manager, then verify the README consistently uses pnpm commands.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
88/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.