feat(site): add interactive getting started guide#280
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
e0bc6d9 to
480955b
Compare
daniel-hayes
commented
Dec 23, 2025
3 tasks
✅ Deploy Preview for vjs10 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
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.
Closes #255
This new getting started guide has three noteworthy features
New components
Pickers
This PR has a bunch of pickers that allow users to select their, e.g., preferred framework in the installation guide. These pickers communicate using the standard nanostore pattern, assembling the user's code block at the end of the doc
Mux Uploader
To enable that upload experience, we integrated
mux-uploader-reactand an overlay which facilitates the user logging into Mux to upload an asset. That flow looks something like this:endpoint.onSuccess, the component will poll the mux direct upload api until the direct upload has an asset id associated with itThat playback id is shared through nanostores with codeblocks later in the installation guide.
But wait. How does that mux api interaction work on the video.js site?
Well, I'm glad you asked:
OAuth for Mux
Summary
Implements OAuth 2.0 authentication with Mux, using a token-based authentication flow with automatic token refresh and session management.
Security Features
Session Management
I decided to use iron-session for encrypting / decrypting cookies on requests. Because of this, you will need to include a secure
SESSION_COOKIE_PASSWORDthat is at least 32 characters long. Their docs suggest creating one here.You will need the following
.envvariables to get the flow working end to end.Check out the
Loginfile to see how we can access this information on the front-end.Unrelated changes
In addition to the above, we also
FRAMEWORK_LABELandSTYLE_LABELconcept so that, when the user has e.g.,cssselected as their style, the UI showsCSSmarginto docs framesclient:visibledirective