rsnext/examples/middleware-matcher
leung018 66597be8a7
Add .yarn/install-state.gz to .gitignore (#56637)
### Reason for making this change
https://yarnpkg.com/getting-started/qa#:~:text=yarn%2Finstall%2Dstate.,your%20workspaces%20all%20over%20again.
In the official documentation of `yarn`, it is stated that `.yarn/install-state.gz` is an optimization file that developer shouldn't ever have to commit. However, currently, when running `create-next-app`, `.yarn/install-state.gz` is being commited.

### Remaining work
I apologize for only modifying one template initially to initiate the discussion first.

If this change is agreed upon,  it should be synchronized with other `.gitignore` templates. Would it be possible to follow a similar approach as in https://github.com/vercel/next.js/pull/47241? I would appreciate any assistance in syncing this change.
2023-10-18 16:34:48 +00:00
..
pages Convert middleware-matcher example to TypeScript (#42520) 2022-11-06 06:08:06 +00:00
.gitignore Add .yarn/install-state.gz to .gitignore (#56637) 2023-10-18 16:34:48 +00:00
middleware.ts Convert middleware-matcher example to TypeScript (#42520) 2022-11-06 06:08:06 +00:00
next-env.d.ts Remove incorrect entries for pnpm debug log (#47241) 2023-03-26 22:26:05 -07:00
package.json Convert middleware-matcher example to TypeScript (#42520) 2022-11-06 06:08:06 +00:00
README.md update example Deploy button URLs (#48842) 2023-04-26 13:31:44 -04:00
tsconfig.json Convert middleware-matcher example to TypeScript (#42520) 2022-11-06 06:08:06 +00:00

Middleware

This example shows how to configure your Next.js Middleware to only match specific pages.

The index page (pages/index.ts) has a list of links to dynamic pages, which will tell whether they were matched or not.

The Middleware file (middleware.ts) has a special matcher configuration key, allowing you to fine-grained control matched pages.

Please keep in mind that:

  1. Middleware always runs first
  2. Middleware always matches _next routes on server side
  3. matcher must always starts with a '/'

Deploy your own

Deploy the example using Vercel:

Deploy with Vercel

How to use

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

npx create-next-app --example middleware-matcher middleware-matcher-app
yarn create next-app --example middleware-matcher middleware-matcher-app
pnpm create next-app --example middleware-matcher middleware-matcher-app

Deploy it to the cloud with Vercel (Documentation).