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
54 lines
2.1 KiB
Markdown
54 lines
2.1 KiB
Markdown
<!-- markdownlint-disable-next-line -->
|
||
<p align="center">
|
||
<a href="https://mui.com/joy-ui/getting-started/" rel="noopener" target="_blank"><img width="150" height="133" src="https://mui.com/static/logo.svg" alt="Joy UI logo"></a>
|
||
</p>
|
||
|
||
<h1 align="center">Joy UI</h1>
|
||
|
||
Joy UI is an open-source React component library that implements MUI's own design principles. It's comprehensive and can be used in production out of the box.
|
||
|
||
## Installation
|
||
|
||
Install the package in your project directory with:
|
||
|
||
```bash
|
||
npm install @mui/joy @emotion/react @emotion/styled
|
||
```
|
||
|
||
## Documentation
|
||
|
||
Visit [https://mui.com/joy-ui/getting-started/](https://mui.com/joy-ui/getting-started/) to view the full documentation.
|
||
|
||
## Questions
|
||
|
||
For how-to questions that don't involve making changes to the code base, please use [Stack Overflow](https://stackoverflow.com/questions/tagged/joy-ui) instead of GitHub issues.
|
||
Use the "joy-ui" tag on Stack Overflow to make it easier for the community to find your question.
|
||
|
||
## Examples
|
||
|
||
The documentation features [a collection of example projects using Joy UI](https://github.com/mui/material-ui/tree/master/examples).
|
||
|
||
## Contributing
|
||
|
||
Read the [contributing guide](/CONTRIBUTING.md) to learn about the development process, how to propose bug fixes and improvements, and how to build and test your changes.
|
||
|
||
Contributing to Joy UI is about more than just issues and pull requests!
|
||
There are many other ways to [support Joy UI](https://mui.com/material-ui/getting-started/faq/#mui-is-awesome-how-can-i-support-the-project) beyond contributing to the code base.
|
||
|
||
## Changelog
|
||
|
||
The [changelog](https://github.com/mui/material-ui/releases) is regularly updated to reflect what's changed in each new release.
|
||
|
||
## Roadmap
|
||
|
||
Future plans and high-priority features and enhancements can be found in the [roadmap](https://mui.com/material-ui/discover-more/roadmap/).
|
||
|
||
## License
|
||
|
||
This project is licensed under the terms of the
|
||
[MIT license](/LICENSE).
|
||
|
||
## Security
|
||
|
||
For details of supported versions and contact details for reporting security issues, please refer to the [security policy](https://github.com/mui/material-ui/security/policy).
|