Merge pull request #56 from deepumandal/48-readmemd

48 readmemd

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
+<p align="center" style="display: flex; justify-content: center; align-items: center;">
+  <img src="https://raw.githubusercontent.com/github/explore/main/topics/react/react.png" alt="React Logo" width="80" height="80"/>
+  <span style="font-size: 2em; margin: 0 10px;">+</span>
+  <img src="https://raw.githubusercontent.com/github/explore/main/topics/vite/vite.png" alt="Vite Logo" width="80" height="80"/> 
+  <span style="font-size: 2em; margin: 0 10px;">+</span>
+  <img src="https://raw.githubusercontent.com/github/explore/main/topics/typescript/typescript.png" alt="TypeScript Logo" width="80" height="80"/>
+</p>
+
+## 🚀 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.

docs/index.md

@@ -0,0 +1 @@
+# Hello

package.json

@@ -75,6 +75,10 @@
     "src/**/*.css": [
       "prettier --write",
       "pnpm spellcheck"
+    ],
+    "src/**/*.md": [
+      "prettier --write",
+      "pnpm spellcheck"
     ]
   },
   "engines": {