-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update README to reflect switch to standalone #1155
Conversation
README.md
Outdated
## Private repo setup (.npmrc) | ||
|
||
The app requires a Git token for access to private repos (currently limited to `design-system-react`). | ||
The app requires a Git token for access to private repos (currently limited to [`design-system-react`](https://github.com/RaspberryPiFoundation/design-system-react). | ||
|
||
- Generated a token here, it'll be prefixed with `ghp_`: https://github.com/settings/tokens | ||
- Generate a token [here](https://github.com/settings/tokens) - it should be prefixed with `ghp_` | ||
- Add a line to the bottom of `~/.npmrc` (this is in addition to the one in the repo): `//npm.pkg.github.com/:_authToken=<github_token>` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔧 I don't think this is true anymore. Both design system packages are public I believe:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah yes okay, I might just get rid of this lot then 👍
README.md
Outdated
Other variables that pertain to the app, rather than its deployment are set with defaults in the [build-and-deploy workflow](./.github/workflows/build-and-deploy.yml). These are also in `.env.example`. | ||
Other variables that pertain to the app, rather than its deployment, are set to default values in the [build-and-deploy workflow file](./.github/workflows/build-and-deploy.yml). These are also in `.env.example`. | ||
|
||
The staging bucket is called [`editor-dist-staging`](https://dash.cloudflare.com/44a2049cd9f2b11d21474e06251367df/r2/default/buckets/editor-dist-staging), and the latest deployment of `main` is available at https://staging-editor-static.raspberrypi.org/branches/main/web-component.html. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❓ is it worth mentioning the staging js bundle is located at https://staging-editor-static.raspberrypi.org/branches/main/web-component.js
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah okay, yeah, I might rework this bit a little then to make clear the bundle and preview locations 👍
Co-authored-by: Scott Adams <[email protected]>
Co-authored-by: Scott Adams <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🙌 great changes!!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚀🚀🚀
No description provided.