rsnext/examples/with-react-md-typescript
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
..
components Run next/link codemod for Next.js 13 on examples (#41913) 2022-10-30 21:00:45 +01:00
pages [Examples] Update react-md examples for v2 (#15723) 2020-08-05 14:24:20 -04:00
styles [Examples] Update react-md examples for v2 (#15723) 2020-08-05 14:24:20 -04:00
.gitignore Add .yarn/install-state.gz to .gitignore (#56637) 2023-10-18 16:34:48 +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 Examples to use React 18 (#42027) 2022-10-28 17:43:20 +00:00
README.md update example Deploy button URLs (#48842) 2023-04-26 13:31:44 -04:00
tsconfig.json Update tsconfig of example to be consistent with default output of next.js (#25581) 2021-06-03 22:31:14 +00:00

ReactMD, Next.js, and Typescript Example

This example sets up a simple ReactMD, Next.js, and Typescript app featuring:

  • _variables.scss to override the default react-md theme and feature toggles
  • app.scss global styles that conditionally apply the dark theme based on the user's OS preferences
  • a custom _app.tsx that uses a persistent layout
  • a reusable Layout.tsx that:
    • updates all the icons to use SVGIcons instead of FontIcons
    • initializes the Layout component from react-md with navigation items

For more information about ReactMD's features, styling, components, and API, check out the main documentation. You can also view the documentation site's source code for a more complex example of using ReactMD + Next.js.

Deploy your own

Deploy the example using Vercel or preview live with StackBlitz

Deploy with Vercel

How to use

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

npx create-next-app --example with-react-md-typescript with-react-md-typescript-app
yarn create next-app --example with-react-md-typescript with-react-md-typescript-app
pnpm create next-app --example with-react-md-typescript with-react-md-typescript-app

Deploy it to the cloud with Vercel (Documentation).