Skip to content

Commit da296d3

Browse files
ihabadhamclaude
andcommitted
docs: add GitHub Packages authentication setup instructions
Add comprehensive setup instructions for GitHub Packages authentication required to install React on Rails Pro dependencies. Changes: - Add Prerequisites section with step-by-step token creation - Document npm configuration for @shakacode-tools packages - Document Bundler configuration for rubygems.pkg.github.com - Add note about installation failure without authentication - Clarify that each developer needs their own GitHub token This addresses best practices for token management in demo repositories where each developer should use their own credentials rather than sharing tokens. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 5136a8b commit da296d3

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,12 +78,29 @@ This demo includes comprehensive documentation for both developers and AI coding
7878

7979
## 🚀 Quick Start
8080

81+
### Prerequisites: GitHub Packages Authentication
82+
83+
This demo uses **React on Rails Pro** from GitHub Packages. While RORP will be open source soon, it currently requires authentication with your Pro subscription token.
84+
85+
1. **Configure npm for GitHub Packages:**
86+
```bash
87+
npm config set @shakacode-tools:registry https://npm.pkg.github.com
88+
npm config set //npm.pkg.github.com/:_authToken YOUR_PRO_TOKEN
89+
```
90+
91+
2. **Configure Bundler for GitHub Packages:**
92+
```bash
93+
bundle config rubygems.pkg.github.com YOUR_PRO_TOKEN
94+
```
95+
96+
### Installation
97+
8198
```bash
8299
# Clone the demo repository
83100
git clone https://github.com/shakacode/react_on_rails-demo-v15-ssr-auto-registration-bundle-splitting.git
84101
cd react_on_rails-demo-v15-ssr-auto-registration-bundle-splitting
85102

86-
# Install dependencies
103+
# Install dependencies (after configuring GitHub Packages above)
87104
bundle install && npm install
88105

89106
# Start development server
@@ -93,6 +110,8 @@ bundle install && npm install
93110
open http://localhost:3000
94111
```
95112

113+
**Note:** Without GitHub Packages authentication, `bundle install` and `npm install` will fail when trying to download `react_on_rails_pro` and `@shakacode-tools/react-on-rails-pro-node-renderer`.
114+
96115
### 🌐 Demo Components
97116

98117
- **[HelloWorld](http://localhost:3000)** - Lightweight component (12.5KB bundle)

0 commit comments

Comments
 (0)