Skip to content

docs: install the demo with npm ci - #52

Merged
gabchess merged 2 commits into
mainfrom
docs/demo-readme-plain-npm
Sep 26, 2026
Merged

gabchess merged 2 commits into
mainfrom
docs/demo-readme-plain-npm

Conversation

@gabchess

@gabchess gabchess commented Sep 26, 2026 •

Copy link
Copy Markdown
Owner

What changed

The demo app's README told readers to install its dependencies through
Socket. It now uses the same command CI runs to install those
dependencies: npm ci --prefix app. The two demo-run commands in the
README (demo, consumer-demo) now run from the repository root with
--prefix app, since the install step no longer changes into that
directory first.

How to run it

From a clean checkout:

yarn install --frozen-lockfile
yarn sdk:build
npm ci --prefix app
npm --prefix app run demo

Verified: npm --prefix app test passes (51/51), and
tsc -p app/tsconfig.json --noEmit is clean.

Summary by CodeRabbit

  • Documentation
    • Updated app setup instructions to install dependencies with npm ci --prefix app, removing the global Socket CLI prerequisite from the documented setup.
    • Updated the standard demo, custom-RPC example, and consumer proof commands to run through npm --prefix app run, keeping the documented commands consistent with the app’s installation steps.

The demo README told a stranger to install app dependencies through
Socket. Swap it for npm ci --prefix app, the exact command CI runs
(ci.yml:73), so the public instructions match the command that
actually gates the build. Downstream run commands (demo,
consumer-demo) now use --prefix app to stay correct after the
install step no longer cd's into app/, matching the pattern already
used by the revoke-demo section.
@coderabbitai

coderabbitai Bot commented Sep 26, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: 3af74650-16b6-414c-9166-55bb49aef93e

📥 Commits

Reviewing files that changed from the base of the PR and between 84bbf04 and 9a6a41f.

📒 Files selected for processing (1)
  • app/README.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 7 remain after this review.

📜 Recent review details
⏰ Context from checks skipped due to timeout. (2)
  • GitHub Check: test
  • GitHub Check: test
🔇 Additional comments (1)
app/README.md (1)

33-33: LGTM!

Also applies to: 36-36, 42-42, 54-54, 81-81


📝 Walkthrough

Walkthrough

The app README removes the global Socket CLI prerequisite. It documents app installation and demo commands using npm with the app prefix.

Changes

App README commands

Layer / File(s) Summary
Installation and demo commands
app/README.md
The README replaces Socket-based installation instructions with npm ci --prefix app. The standard demo, custom-RPC example, and consumer proof commands now use npm --prefix app run.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to ad2f8

The README now installs the app and runs its demos from the repository root using npm; the documented commands follow the existing CI and app-script conventions, with no concrete merge-blocking issue identified.

Architecture Summary

Architecture risk: 🔵 Low · up to 9a6a4

The change affects 1 system.

Changed systems: app

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — app (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in app/README.md: The prerequisite for globally installing Socket was removed.
  • observed — Modified behavior in app/README.md: The app installation instructions replace changing into app and running socket npm install with npm ci --prefix app.
  • observed — Modified behavior in app/README.md: The standard demo command now runs through npm --prefix app run demo instead of running npm run demo from within the app directory.
  • observed — Modified behavior in app/README.md: The custom-RPC example now invokes the demo with npm --prefix app run demo.
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the README changes and includes run instructions and verification results. It does not include the required Public repository check section or its checklist responses. Add the complete Public repository check section from the repository template. Confirm each checklist item and report whether npm run public:check passes.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change: installing the demo with npm ci.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

A rabbit hops past Socket’s door,
With npm commands ready to run.
From the root, the demos launch,
The app installs with one clear step.
Then carrots wait beneath the sun.

Comment @coderabbitai help to get the list of available commands.

@gabchess
gabchess merged commit ee59118 into main Sep 26, 2026
5 checks passed
@gabchess
gabchess deleted the docs/demo-readme-plain-npm branch September 26, 2026 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant