History

Dylan Jhaveri e952160049 Update Mux example logo to new Mux brand (#48654 ) <!-- Thanks for opening a PR! Your contribution is much appreciated. To make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below. Choose the right checklist for the change(s) that you're making: ## For Contributors ### Improving Documentation or adding/fixing Examples - The "examples guidelines" are followed from our contributing doc https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md - Make sure the linting passes by running `pnpm build && pnpm lint`. See https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md ### Fixing a bug - Related issues linked using `fixes #number` - Tests added. See: https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ### Adding a feature - Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. (A discussion must be opened, see https://github.com/vercel/next.js/discussions/new?category=ideas) - Related issues/discussions are linked using `fixes #number` - e2e tests added (https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs - Documentation added - Telemetry added. In case of a feature if it's used or not. - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ## For Maintainers - Minimal description (aim for explaining to someone not on the team to understand the PR) - When linking to a Slack thread, you might want to share details of the conclusion - Link both the Linear (Fixes NEXT-xxx) and the GitHub issues - Add review comments if necessary to explain to the reviewer the logic behind a change ### What? ### Why? ### How? Closes NEXT- Fixes # -->		2023-04-20 23:45:43 +00:00
..
components	Convert `with-gsap`, `with-mqtt-js`, `with-mux-video` examples to Typescript (#43874 )	2022-12-12 01:53:08 +00:00
pages	update Mux Player to latest, pin to ^1 and pin upchunk to ^3 add Mux … (#45121 )	2023-01-20 15:56:57 -08:00
public	Update Mux example logo to new Mux brand (#48654 )	2023-04-20 23:45:43 +00:00
.env.local.example	Add example: with-mux-video (#13120 )	2020-05-22 16:13:12 -05:00
.gitignore	Remove incorrect entries for pnpm debug log (#47241 )	2023-03-26 22:26:05 -07:00
constants.ts	Convert `with-gsap`, `with-mqtt-js`, `with-mux-video` examples to Typescript (#43874 )	2022-12-12 01:53:08 +00:00
next-env.d.ts	Remove incorrect entries for pnpm debug log (#47241 )	2023-03-26 22:26:05 -07:00
package.json	update Mux Player to latest, pin to ^1 and pin upchunk to ^3 add Mux … (#45121 )	2023-01-20 15:56:57 -08:00
README.md	docs(examples): improve DX while copying command to create new project (#38410 )	2022-07-26 21:57:48 -05:00
tsconfig.json	Convert `with-gsap`, `with-mqtt-js`, `with-mux-video` examples to Typescript (#43874 )	2022-12-12 01:53:08 +00:00
vercel.json	Add example: with-mux-video (#13120 )	2020-05-22 16:13:12 -05:00

README.md

Mux Video

This example uses Mux Video, an API-first platform for video. The example features video uploading and playback in a Next.js application.

Demo

https://with-mux-video.vercel.app/

This project was used to create stream.new

Deploy your own

Deploy the example using Vercel:

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example with-mux-video with-mux-video-app

yarn create next-app --example with-mux-video with-mux-video-app

pnpm create next-app --example with-mux-video with-mux-video-app

Note

Important: When creating uploads, this demo sets cors_origin: "*" in the pages/api/upload.js file. For extra security, you should update this value to be something like cors_origin: 'https://your-app.com', to restrict uploads to only be allowed from your application.

This example uses:

SWR — dynamically changing the refreshInterval depending on if the client should be polling for updates or not
/pages/api routes — a couple endpoints for making authenticated requests to the Mux API.
Dynamic routes using getStaticPaths and fallback: true, as well as dynamic API routes.

Configuration

Step 1. Create an account in Mux

All you need to set this up is a Mux account. You can sign up for free and pricing is pay-as-you-go. There are no upfront charges, you get billed monthly only for what you use.

Without entering a credit card on your Mux account all videos are in “test mode” which means they are watermarked and clipped to 10 seconds. If you enter a credit card all limitations are lifted and you get $20 of free credit. The free credit should be plenty for you to test out and play around with everything before you are charged.

Step 2. Set up environment variables

Copy the .env.local.example file in this directory to .env.local (which will be ignored by Git):

cp .env.local.example .env.local

Then, go to the settings page in your Mux dashboard set each variable on .env.local, get a new API Access Token and set each variable in .env.local:

MUX_TOKEN_ID should be the TOKEN ID of your new token
MUX_TOKEN_SECRET should be TOKEN SECRET

Step 3. Deploy on Vercel

You can deploy this app to the cloud with Vercel (Documentation).

To deploy on Vercel, you need to set the environment variables using Vercel CLI (Documentation).

Install the Vercel CLI, log in to your account from the CLI, and run the following commands to add the environment variables. Replace the values with the corresponding strings in .env.local:

vercel secrets add next_example_mux_token_id <MUX_TOKEN_ID>
vercel secrets add next_example_mux_token_secret <MUX_TOKEN_SECRET>

Then push the project to GitHub/GitLab/Bitbucket and import to Vercel to deploy.