Skip to content

Commit 79d57a5

Browse files
authored
Merge pull request #3128 from telerik/publish-tailwind-demo
publish tailwind demo
2 parents 82bd3b9 + bb69a1a commit 79d57a5

27 files changed

+6784
-2
lines changed

.github/dependabot.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,24 @@ updates:
254254

255255
- package-ecosystem: "npm"
256256
directory: "/examples/react-grid-live-data"
257+
schedule:
258+
interval: "daily"
259+
groups:
260+
kendo-dependencies:
261+
patterns:
262+
- '@progress/kendo-*'
263+
allow:
264+
- dependency-name: '@progress/kendo-*'
265+
commit-message:
266+
prefix: "chore:"
267+
reviewers:
268+
- "telerik/kendo-react-devs"
269+
- "telerik/kendo-react-support"
270+
labels:
271+
- "Dependencies"
272+
273+
- package-ecosystem: "npm"
274+
directory: "/examples/kendo-react-tailwind"
257275
schedule:
258276
interval: "daily"
259277
groups:

.github/workflows/ci.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@ jobs:
6363
- 'examples/react-coffee-warehouse/**'
6464
react-grid-live-data:
6565
- 'examples/react-grid-live-data/**'
66+
kendo-react-tailwind:
67+
- 'examples/kendo-react-tailwind/**'
6668
6769
- name: Build Coffee warehouse nextjs app
6870
working-directory: ./examples/coffee-warehouse-nextjs
@@ -189,6 +191,13 @@ jobs:
189191
- name: Build React Grid Live Data app
190192
working-directory: ./examples/react-grid-live-data
191193
if: steps.changes.outputs.react-grid-live-data == 'true'
194+
run: |
195+
npm ci
196+
npm run build
197+
198+
- name: Build Kendo React Tailwind app
199+
working-directory: ./examples/kendo-react-tailwind
200+
if: steps.changes.outputs.kendo-react-tailwind == 'true'
192201
run: |
193202
npm ci
194203
npm run build
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
pnpm-debug.log*
8+
lerna-debug.log*
9+
10+
node_modules
11+
dist
12+
dist-ssr
13+
*.local
14+
15+
# Editor directories and files
16+
.vscode/*
17+
!.vscode/extensions.json
18+
.idea
19+
.DS_Store
20+
*.suo
21+
*.ntvs*
22+
*.njsproj
23+
*.sln
24+
*.sw?
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Add files here to ignore them from prettier formatting
2+
/dist
3+
/coverage
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"printWidth": 120,
3+
"tabWidth": 4,
4+
"singleQuote": true,
5+
"trailingComma": "none"
6+
}
Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
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/)
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
import js from '@eslint/js'
2+
import globals from 'globals'
3+
import reactHooks from 'eslint-plugin-react-hooks'
4+
import reactRefresh from 'eslint-plugin-react-refresh'
5+
import tseslint from 'typescript-eslint'
6+
7+
export default tseslint.config(
8+
{ ignores: ['dist'] },
9+
{
10+
extends: [js.configs.recommended, ...tseslint.configs.recommended],
11+
files: ['**/*.{ts,tsx}'],
12+
languageOptions: {
13+
ecmaVersion: 2020,
14+
globals: globals.browser,
15+
},
16+
plugins: {
17+
'react-hooks': reactHooks,
18+
'react-refresh': reactRefresh,
19+
},
20+
rules: {
21+
...reactHooks.configs.recommended.rules,
22+
'react-refresh/only-export-components': [
23+
'warn',
24+
{ allowConstantExport: true },
25+
],
26+
},
27+
},
28+
)
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<title>Vite + React + TS</title>
8+
</head>
9+
<body>
10+
<div id="root"></div>
11+
<script type="module" src="/src/main.tsx"></script>
12+
</body>
13+
</html>

0 commit comments

Comments
 (0)