From fa7b4457360d9682f44d427c46b41dbd01f8012e Mon Sep 17 00:00:00 2001 From: DEEPAK KUMAR MANDAL Date: Mon, 5 Aug 2024 17:39:29 +0530 Subject: [PATCH 1/2] docs testing --- README.md | 53 ++++++++++++++++++++++----------------------------- docs/index.md | 1 + 2 files changed, 24 insertions(+), 30 deletions(-) create mode 100644 docs/index.md diff --git a/README.md b/README.md index e1cdc89..ce82d14 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,23 @@ -# React + TypeScript + Vite - -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. - -Currently, two official plugins are available: - -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh - -## Expanding the ESLint configuration - -If you are developing a production application, we recommend updating the configuration to enable type aware lint rules: - -- Configure the top-level `parserOptions` property like this: - -```js -export default { - // other rules... - parserOptions: { - ecmaVersion: 'latest', - sourceType: 'module', - project: ['./tsconfig.json', './tsconfig.node.json', './tsconfig.app.json'], - tsconfigRootDir: __dirname, - }, -} -``` - -- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked` -- Optionally add `plugin:@typescript-eslint/stylistic-type-checked` -- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list +

+ React Logo + + + Vite Logo + + + TypeScript Logo +

+ +## 🚀 Introduction + +Welcome to this Vite template repository! If you're looking for a modern, 2024-ready React-based template with all the essential tools and technologies pre-configured, you're in the right place. + +### 🛠️ Features + +- **React + TypeScript**: Robust and scalable web setup. +- **Vite**: Fast build tool. +- **Code Quality Tools**: Ensure clean and maintainable code with: + - **Husky**: to make a good commit every time. + - **prettier**: to make a preety code. + - **Eslint**: make rules and leave rest to eslint and sit back then see hwo this tool will find bugs for you. +- **TailwindCSS**: Utility-first CSS framework. +- **Redux**: State management. +- **Prebuilt UI components**: Ready to use.use. diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..fec5601 --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +# Hello From ad98bc12a754697e2ddc6f02d6b2f4d88722a959 Mon Sep 17 00:00:00 2001 From: DEEPAK KUMAR MANDAL Date: Mon, 5 Aug 2024 17:40:21 +0530 Subject: [PATCH 2/2] docs lint staged added --- package.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/package.json b/package.json index 12c4edb..3948e81 100644 --- a/package.json +++ b/package.json @@ -75,6 +75,10 @@ "src/**/*.css": [ "prettier --write", "pnpm spellcheck" + ], + "src/**/*.md": [ + "prettier --write", + "pnpm spellcheck" ] }, "engines": {