Skip to content
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

Merged
merged 24 commits into from
Dec 19, 2024
Merged

Conversation

loiswells97
Copy link
Contributor

No description provided.

@loiswells97 loiswells97 temporarily deployed to previews/1155/merge December 16, 2024 17:08 — with GitHub Actions Inactive
@loiswells97 loiswells97 temporarily deployed to previews/1155/merge December 16, 2024 17:35 — with GitHub Actions Inactive
@loiswells97 loiswells97 temporarily deployed to previews/1155/merge December 17, 2024 10:19 — with GitHub Actions Inactive
@loiswells97 loiswells97 temporarily deployed to previews/1155/merge December 17, 2024 10:20 — with GitHub Actions Inactive
@loiswells97 loiswells97 temporarily deployed to previews/1155/merge December 17, 2024 10:22 — with GitHub Actions Inactive
@loiswells97 loiswells97 temporarily deployed to previews/1155/merge December 17, 2024 10:23 — with GitHub Actions Inactive
@loiswells97 loiswells97 temporarily deployed to previews/1155/merge December 17, 2024 10:23 — with GitHub Actions Inactive
README.md Outdated
Comment on lines 13 to 18
## 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>`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

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 👍

CHANGELOG.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
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.
Copy link
Contributor

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?

Copy link
Contributor Author

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]>
@loiswells97 loiswells97 temporarily deployed to previews/1155/merge December 17, 2024 11:37 — with GitHub Actions Inactive
Co-authored-by: Scott Adams <[email protected]>
@loiswells97 loiswells97 temporarily deployed to previews/1155/merge December 17, 2024 11:39 — with GitHub Actions Inactive
@loiswells97 loiswells97 temporarily deployed to previews/1155/merge December 17, 2024 11:50 — with GitHub Actions Inactive
@loiswells97 loiswells97 temporarily deployed to previews/1155/merge December 17, 2024 11:57 — with GitHub Actions Inactive
@loiswells97 loiswells97 temporarily deployed to previews/1155/merge December 17, 2024 12:37 — with GitHub Actions Inactive
@loiswells97 loiswells97 temporarily deployed to previews/1155/merge December 17, 2024 13:03 — with GitHub Actions Inactive
@loiswells97 loiswells97 temporarily deployed to previews/1155/merge December 17, 2024 14:24 — with GitHub Actions Inactive
@loiswells97 loiswells97 temporarily deployed to previews/1155/merge December 17, 2024 15:30 — with GitHub Actions Inactive
@loiswells97 loiswells97 temporarily deployed to previews/1155/merge December 17, 2024 15:53 — with GitHub Actions Inactive
@loiswells97 loiswells97 temporarily deployed to previews/1155/merge December 17, 2024 16:08 — with GitHub Actions Inactive
@loiswells97 loiswells97 temporarily deployed to previews/1155/merge December 17, 2024 16:10 — with GitHub Actions Inactive
@loiswells97 loiswells97 temporarily deployed to previews/1155/merge December 17, 2024 16:25 — with GitHub Actions Inactive
@loiswells97 loiswells97 temporarily deployed to previews/1155/merge December 17, 2024 16:27 — with GitHub Actions Inactive
Copy link
Contributor

@sra405 sra405 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙌 great changes!!

Copy link
Contributor

@KristinaDudnyk KristinaDudnyk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀🚀🚀

@loiswells97 loiswells97 merged commit 8204181 into main Dec 19, 2024
8 checks passed
@loiswells97 loiswells97 deleted the update-readme-dec-2024 branch December 19, 2024 15:58
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.

4 participants