docs: Add guidance for running admin scripts #125
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation to guide developers and AI agents on running admin scripts from the correct directory. The changes clarify that npm scripts must be executed from the server/ directory and document the module loading pattern used by standalone scripts.
Key Changes
- Added "Critical Module Loading Pattern for Scripts" section explaining the
createRequirepattern needed for scripts in thescripts/directory to access server dependencies - Added "Running Admin Scripts" section with execution examples for admin commands
- Updated
.gitignoreto exclude generated coupon PDFs (alongside existing seed PDFs)
Reviewed Changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
.github/copilot-instructions.md |
Added two new sections documenting script module loading patterns and execution instructions from the server directory |
.gitignore |
Added scripts/coupons/ to ignore generated coupon PDF files |
| npm run super-admin -- list # List all super admins | ||
| npm run super-admin -- create John Doe [email protected] +15551234567 <locationId> | ||
| npm run generate-seeds -- "Hub Name" 10 # Generate 10 seed QR codes | ||
| npm run generate-coupons -- 5 # Generate 5 blank coupon pages |
There was a problem hiding this comment.
The generate-coupons script referenced in this documentation does not exist in server/package.json. Only super-admin and generate-seeds scripts are currently defined. Either remove this example or add the missing script definition to server/package.json.
Suggested change
| npm run generate-coupons -- 5 # Generate 5 blank coupon pages |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updated .github/copilot-instructions.md to add explicit guidance about running admin scripts from the server/ directory.
Changes
Why
AI agents and developers need clear guidance on where to execute scripts to avoid path-related errors.
Testing