Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Add and revise Base UI + Create React App examples #36825

Merged
merged 19 commits into from
Jun 22, 2023
Merged

[docs] Add and revise Base UI + Create React App examples #36825

merged 19 commits into from
Jun 22, 2023

Conversation

mapache-salvaje
Copy link
Contributor

@mapache-salvaje mapache-salvaje commented Apr 9, 2023

Part of #36193

  • add Base UI + Create React App (JavaScript) example
  • clean up Base + CRA TypeScript example
  • add more details to READMEs
  • improve startup pages

Startup page before:

Screenshot 2023-04-12 at 7 04 50 PM

After:

Screenshot 2023-04-12 at 7 04 08 PM

@mapache-salvaje mapache-salvaje added docs Improvements or additions to the documentation package: base-ui Specific to @mui/base examples Relating to /examples labels Apr 9, 2023
@mui-bot
Copy link

mui-bot commented Apr 9, 2023

Netlify deploy preview

https://deploy-preview-36825--material-ui.netlify.app/

Bundle size report

No bundle size changes

Generated by 🚫 dangerJS against 2da036e

@mapache-salvaje mapache-salvaje removed the request for review from michaldudak April 13, 2023 00:07
@mapache-salvaje
Copy link
Contributor Author

I know my startup page isn't the most beautiful thing in the world, but I think it's an improvement nonetheless! 😅 I wanted it to be helpful but didn't want to invest too much time into making it pretty.

@michaldudak
Copy link
Member

I wonder if we should invest in CRA examples as it's no longer a recommended way of starting a React project (reactjs/react.dev#5487 (comment), https://react.dev/learn/start-a-new-react-project)
Having Vite as a SPA example seems to be more future-proof

@mapache-salvaje
Copy link
Contributor Author

mapache-salvaje commented Apr 13, 2023

I wonder if we should invest in CRA examples as it's no longer a recommended way of starting a React project (reactjs/react.dev#5487 (comment), https://react.dev/learn/start-a-new-react-project) Having Vite as a SPA example seems to be more future-proof

@michaldudak my goal in #36193 is to reach parity with Material UI for Base and Joy examples. I think CRA is still relevant and worth keeping around, even if it is falling out of fashion.

I'll move on to Vite examples from here so we'll have those ready before the stable release. After that I think Next.js and Tailwind CSS will be the highest priorities.

.codesandbox/ci.json Outdated Show resolved Hide resolved
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Apr 24, 2023
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jun 14, 2023
@mapache-salvaje
Copy link
Contributor Author

I know CRA isn't a big priority but we might as well merge this since it's here. 😅 Can I get a final review?

@mapache-salvaje
Copy link
Contributor Author

...Or maybe we don't want any CRA examples anymore? See: #37367

Copy link
Member

@michaldudak michaldudak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's go ahead and add these since you've already spent some time on them. I wouldn't create any new ones after that, though.

examples/base-cra/src/App.js Outdated Show resolved Hide resolved
examples/base-cra/src/App.js Outdated Show resolved Hide resolved
examples/base-cra/package.json Outdated Show resolved Hide resolved
examples/base-cra-ts/src/App.tsx Outdated Show resolved Hide resolved
examples/base-cra-ts/src/App.tsx Outdated Show resolved Hide resolved
@mapache-salvaje mapache-salvaje merged commit 2f0c21e into mui:master Jun 22, 2023
@mapache-salvaje mapache-salvaje deleted the base-cra branch April 3, 2024 17:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation examples Relating to /examples package: base-ui Specific to @mui/base
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants