005cf56baf
Some checks failed
No response / noResponse (push) Has been cancelled
CI / Continuous releases (push) Has been cancelled
CI / test-dev (macos-latest) (push) Has been cancelled
CI / test-dev (ubuntu-latest) (push) Has been cancelled
CI / test-dev (windows-latest) (push) Has been cancelled
Maintenance / main (push) Has been cancelled
Scorecards supply-chain security / Scorecards analysis (push) Has been cancelled
CodeQL / Analyze (push) Has been cancelled
44 lines
1.4 KiB
Markdown
44 lines
1.4 KiB
Markdown
# Joy UI - Vite.js in TypeScript example
|
||
|
||
[Joy UI](https://mui.com/joy-ui/getting-started/) is a library of beautifully designed React UI components built to spark joy in the development process.
|
||
|
||
[Vite](https://vite.dev/) is a build tool that aims to provide a faster and leaner development experience for modern web projects, consisting of a dev server and a build command.
|
||
|
||
## How to use
|
||
|
||
Download the example [or clone the repo](https://github.com/mui/material-ui):
|
||
|
||
<!-- #target-branch-reference -->
|
||
|
||
```bash
|
||
curl https://codeload.github.com/mui/material-ui/tar.gz/master | tar -xz --strip=2 material-ui-master/examples/joy-ui-vite-ts
|
||
cd joy-ui-vite-ts
|
||
```
|
||
|
||
Install it and run:
|
||
|
||
```bash
|
||
npm install
|
||
npm run dev
|
||
```
|
||
|
||
or:
|
||
|
||
<!-- #target-branch-reference -->
|
||
|
||
[](https://stackblitz.com/github/mui/material-ui/tree/master/examples/joy-ui-vite-ts)
|
||
|
||
[](https://codesandbox.io/p/sandbox/github/mui/material-ui/tree/master/examples/joy-ui-vite-ts)
|
||
|
||
## The idea behind the example
|
||
|
||
This example uses [Vite.js](https://github.com/vitejs/vite).
|
||
It includes `@mui/joy` and it's peer dependencies.
|
||
|
||
## What's next?
|
||
|
||
<!-- #host-reference -->
|
||
|
||
You now have a working example project.
|
||
You can head back to the documentation and continue by browsing the [templates](https://mui.com/joy-ui/getting-started/templates/) section.
|