|
| 1 | +# KendoReact + TailwindCSS + Vite |
| 2 | + |
| 3 | +This project is a React application built with TypeScript, Vite, and TailwindCSS. It also integrates KendoReact components for enterprise-grade UI functionality. |
| 4 | + |
| 5 | +## Getting Started |
| 6 | + |
| 7 | +### Prerequisites |
| 8 | + |
| 9 | +Ensure you have the following installed: |
| 10 | + |
| 11 | +- [Node.js](https://nodejs.org/) (version 16 or higher) |
| 12 | +- [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/) |
| 13 | + |
| 14 | +### Installation |
| 15 | + |
| 16 | +1. Install dependencies: |
| 17 | + ```bash |
| 18 | + npm install |
| 19 | + ``` |
| 20 | + |
| 21 | +### Development |
| 22 | + |
| 23 | +Start the development server with hot module replacement: |
| 24 | + |
| 25 | +```bash |
| 26 | +npm run dev |
| 27 | +``` |
| 28 | + |
| 29 | +The application will be available at [http://localhost:5173](http://localhost:5173). |
| 30 | + |
| 31 | +### Build |
| 32 | + |
| 33 | +To create a production build: |
| 34 | + |
| 35 | +```bash |
| 36 | +npm run build |
| 37 | +``` |
| 38 | + |
| 39 | +The build output will be in the `dist` directory. |
| 40 | + |
| 41 | +### Preview |
| 42 | + |
| 43 | +To preview the production build: |
| 44 | + |
| 45 | +```bash |
| 46 | +npm run preview |
| 47 | +``` |
| 48 | + |
| 49 | +## Project Structure |
| 50 | + |
| 51 | +- **`src/`**: Contains the source code. |
| 52 | + - **`components/`**: Reusable React components. |
| 53 | + - **`App.tsx`**: Main application component. |
| 54 | + - **`main.tsx`**: Entry point for the React application. |
| 55 | + - **`index.css`**: TailwindCSS and custom styles. |
| 56 | +- **`public/`**: Static assets. |
| 57 | +- **`vite.config.ts`**: Vite configuration file. |
| 58 | +- **`tsconfig.*.json`**: TypeScript configuration files. |
| 59 | + |
| 60 | +## Styling |
| 61 | + |
| 62 | +This project uses TailwindCSS for styling. Custom styles and variables are defined in `src/index.css`. KendoReact components are styled using the Kendo Default Theme, with some overrides for Tailwind compatibility. |
| 63 | + |
| 64 | +## Linting and Formatting |
| 65 | + |
| 66 | +- Run ESLint: |
| 67 | + |
| 68 | + ```bash |
| 69 | + npm run lint |
| 70 | + ``` |
| 71 | + |
| 72 | +- Prettier is configured to format code automatically. You can customize the rules in `.prettierrc`. |
| 73 | + |
| 74 | +## Dependencies |
| 75 | + |
| 76 | +### Main Dependencies |
| 77 | + |
| 78 | +- `react` and `react-dom`: Core React libraries. |
| 79 | +- `@progress/kendo-react-*`: KendoReact components and themes. |
| 80 | +- `tailwindcss`: Utility-first CSS framework. |
| 81 | + |
| 82 | +### Dev Dependencies |
| 83 | + |
| 84 | +- `vite`: Build tool. |
| 85 | +- `typescript`: TypeScript support. |
| 86 | +- `eslint`: Linter for JavaScript and TypeScript. |
| 87 | +- `prettier`: Code formatter. |
| 88 | + |
| 89 | +## Learn More |
| 90 | + |
| 91 | +- [Vite Documentation](https://vitejs.dev/) |
| 92 | +- [React Documentation](https://reactjs.org/) |
| 93 | +- [TailwindCSS Documentation](https://tailwindcss.com/) |
| 94 | +- [KendoReact Documentation](https://www.telerik.com/kendo-react-ui/) |
0 commit comments