> **NOTE:** This is a community project, not associated with [Vercel](https://vercel.com), but does get some inspiration from there.
## Getting Started
Visit https://tridentui.org/guide to get started with TridentUI.
## Documentation
Visit [https://tridentui.org/docs](https://tridentui.org/docs) to view the full documentation.
## Quick Start
1. Installation: Inside your React project directory, install TridentUI by running either of the following:
```bash
yarn add @tridentui/react
# or
npm i @tridentui/react
```
2. Setup: For TridentUI to work correctly, you need to set up the CssBaseline at the root of your application.
Go to the root of your application and do this:
```jsx
import { NextUIProvider } from '@tridentui/react';
const Application = () => (
// ---> Your App Component
);
```
3. Using TridentUI components: Once TridentUI is installed you can use any of the components as follows.
TridentUI uses tree-shaking so the unused modules will not be included in the bundle during the build process and
each component is exported separately.
```jsx
import { Button } from '@tridentui/react';
const Component = () => ;
```
4. TridentUI allows to manually import components if you need. E.g.
```jsx
import Button from '@tridentui/react/button';
const Component = () => ;
```
### Community
We're excited to see the community adopt TridentUI, raise issues, and provide feedback.
Whether it's a feature request, bug report, or a project to showcase, please get involved!
- [Discord](https://discord.gg/9b6yyZKmH4)
- [Twitter](https://twitter.com/getnextui)
- [GitHub Discussions](https://github.com/tridentui-org/tridentui/discussions)
## Contributing
Contributions are always welcome!
See [CONTRIBUTING.md](https://github.com/tridentui-org/tridentui/blob/main/CONTRIBUTING.MD) for ways to get started.
Please adhere to this project's [CODE_OF_CONDUCT](https://github.com/tridentui-org/tridentui/blob/main/CODE_OF_CONDUCT.md).
## License
[MIT](https://choosealicense.com/licenses/mit/)
