@mais-tech/renault-ui-library/README.md

UI component library for Renault applications.

# Renault UI Library

This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app), designed to integrate with our `renault-ui-library` library. This setup includes a suite of Kendo UI React components and is optimized for building interactive user interfaces with efficiency and ease.

## Getting Started

To get the development server running:

```bash
npm run dev
# or
yarn dev
```

Navigate to [http://localhost:3000](http://localhost:3000) in your browser to see the application in action.

Edit `app/page.tsx` to start modifying your page. Save the file and observe the updates automatically reflecting in the browser.

We've incorporated [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) for optimized loading of 'Roboto', a custom font from Google Fonts.

## Unit and Snapshot Testing

Our commitment to quality means we've implemented unit tests to verify that each component renders correctly with all props provided. Run the tests with:

```bash
npm run test
# or
yarn test
```

For a detailed coverage report, use:

```bash
npm run test:coverage
# or
yarn test:coverage
```

## Storybook Integration

To view and interact with the components in isolation, we utilize Storybook:

```bash
npm run storybook
# or
yarn storybook
```

Open [http://localhost:6006](http://localhost:6006) to access the Storybook UI.

## Learn More

For a deeper dive into the specifics of our design system and the technologies we use:

- [Kendo React Components](https://www.telerik.com/kendo-react-ui/components/) - comprehensive guide to the Kendo UI React components.
- [TypeScript](https://www.typescriptlang.org/) - for information on the TypeScript language.
- [Testing with Jest](https://jestjs.io/) - for understanding the Jest framework used in testing.
- [Next.js Documentation](https://nextjs.org/docs) - to learn more about Next.js's features and API.

Your feedback and contributions to our project repository on GitHub are highly appreciated.

## Deploying Your Application

For deployment, Vercel offers a seamless experience to host Next.js applications. Refer to the [Next.js deployment documentation](https://nextjs.org/docs/deployment) for detailed instructions and best practices.