rsnext/examples/with-mobx-state-tree
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 [Docs] Merge with-mobx-state-tree with with-mobx-state-tree-typescript example (#40306) 2022-09-08 12:56:12 +00: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 [Docs] Merge with-mobx-state-tree with with-mobx-state-tree-typescript example (#40306) 2022-09-08 12:56:12 +00:00
README.md update example Deploy button URLs (#48842) 2023-04-26 13:31:44 -04:00
store.ts [Docs] Merge with-mobx-state-tree with with-mobx-state-tree-typescript example (#40306) 2022-09-08 12:56:12 +00:00
tsconfig.json [Docs] Merge with-mobx-state-tree with with-mobx-state-tree-typescript example (#40306) 2022-09-08 12:56:12 +00:00

MobX State Tree with TypeScript example

Usually splitting your app state into pages feels natural but sometimes you'll want to have global state for your app. This is an example on how you can use mobx that also works with our universal rendering approach.

In this example we are going to display a digital clock that updates every second. The first render is happening in the server and the date will be 00:00:00, then the browser will take over and it will start updating the date.

To illustrate SSG and SSR, go to /ssg and /ssr, those pages are using Next.js data fetching methods to get the date in the server and return it as props to the page, and then the browser will hydrate the store and continue updating the date.

The trick here for supporting universal mobx is to separate the cases for the client and the server. When we are on the server we want to create a new store every time, otherwise different users data will be mixed up. If we are in the client we want to use always the same store. That's what we accomplish on store.js

The clock, under components/Clock.js, has access to the state using the inject and observer functions from mobx-react. In this case Clock is a direct child from the page but it could be deep down the render tree.

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-mobx-state-tree with-mobx-state-tree-app
yarn create next-app --example with-mobx-state-tree with-mobx-state-tree-app
pnpm create next-app --example with-mobx-state-tree with-mobx-state-tree-app

Deploy it to the cloud with Vercel (Documentation).