Merge pull request #5 from HellBus1/staging

v1.0.0

Author: HellBus1

.eslintignore

@@ -0,0 +1,3 @@
+reportWebVitals.js 
+setupTests.js 
+vite.config.js 

.eslintrc.cjs

@@ -1,18 +1,31 @@
 module.exports = {
   root: true,
-  env: { browser: true, es2020: true },
+  env: {
+    browser: true, es2020: true,
+  },
   extends: [
     'eslint:recommended',
     'plugin:@typescript-eslint/recommended',
     'plugin:react-hooks/recommended',
   ],
   ignorePatterns: ['dist', '.eslintrc.cjs'],
   parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaFeatures: {
+      tsx: true,
+    },
+    ecmaVersion: 'latest',
+    requireConfigFile: false,
+    sourceType: 'module'
+  },
   plugins: ['react-refresh'],
   rules: {
     'react-refresh/only-export-components': [
       'warn',
       { allowConstantExport: true },
     ],
+    'comma-dangle': ['error', 'never'],
+    'no-underscore-dangle': 'off',
+    'class-methods-use-this': 'off',
   },
 }

.husky/pre-commit

@@ -0,0 +1,6 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+#npm test
+
+npm run lint-staged

.prettierignore

@@ -0,0 +1,6 @@
+# Ignore artifacts
+build
+coverage
+
+# Ignore public content
+public

.prettierrc.json

@@ -0,0 +1,10 @@
+{
+  "semi": false,
+  "tabWidth": 2,
+  "printWidth": 100,
+  "singleQuote": true,
+  "trailingComma": "none",
+  "jsxSingleQuote": true,
+  "bracketSpacing": true,
+  "arrowParens": "always"
+}

README.md

@@ -1,30 +1,66 @@
-# React + TypeScript + Vite
+# Lightweight React JS + Vite Starter Kit Template
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+<https://github.com/user-attachments/assets/2ee04f33-57dd-42d0-80d7-bc173aa76b2e>
 
-Currently, two official plugins are available:
+<div align="center">
+  <!-- <img alt="GitHub release" src="https://img.shields.io/github/v/release//HellBus1/ts-react-tailwind-starter?include_prereleases"> -->
+  <img alt="GitHub react version" src="https://img.shields.io/github/package-json/dependency-version/HellBus1/ts-react-tailwind-starter/react?style=flat">
+</div>
 
-- [@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
+## Description
 
-## Expanding the ESLint configuration
+A React.js template with Vite ⚡ is super simple and ready to go. It comes packed with all the essential libraries you need for modern frontend development.
 
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+### Why Vite?
 
-- Configure the top-level `parserOptions` property like this:
+Here is several things that made vite is better bundler out there :
 
-```js
-export default {
-  // other rules...
-  parserOptions: {
-    ecmaVersion: 'latest',
-    sourceType: 'module',
-    project: ['./tsconfig.json', './tsconfig.node.json', './tsconfig.app.json'],
-    tsconfigRootDir: __dirname,
-  },
-}
+1. **Instant Server Start**: No more waiting around—start your server instantly.
+2. **Lightning Fast HMR**: Hot Module Replacement that's truly fast.
+3. **Create React App Best Alternative**: Skip the unecessary clutter of Create React App 🙂.
+4. **And More**: There are plenty of other reasons to love Vite!
+
+If you’re curious to explore Vite further, check out the [link](https://vitejs.dev/)
+
+## Features
+
+Here is the building blocks of this repository
+
+- 📟 **Navigation**: Configured with [React Router DOM](https://reactrouter.com/en/main) for dynamic routing.
+- 🔋 **CSS Frameworks**: [Tailwind CSS](https://tailwindcss.com/) and [Daisy UI](https://daisyui.com/) for rapid UI development with minimal custom styling.
+- 📊 **Code Formatting**: [Prettier](https://prettier.io/) is integrated to ensure consistent code style across the project.
+- 🗂️ **Linting**: [ESLint](https://eslint.org/) is set up to enforce coding standards and best practices.
+- 📮 **Pre-commit Hooks**: [Husky](https://github.com/lint-staged/lint-staged) is utilized to run automated checks before code is committed.
+- 🛠️ **Lint-Staged**: Paired with Husky, [lint-staged](https://github.com/lint-staged/lint-staged) handles formatting and linting for all staged changes.
+
+## Getting Started
+
+1. **Clone the repository** :
+```shell
+git clone https://github.com/HellBus1/ts-react-tailwind-starter.git
+cd ts-react-tailwind-starter
+```
+
+2. **Install dependencies** :
+```shell
+npm install
 ```
 
-- 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
+3. **Run the development server** :
+```shell
+npm run dev
+```
+
+4. **Build for production** :
+```shell
+npm run build
+```
+
+## Getting Started
+
+Contributions are welcome! Please open an issue or submit a pull request.
+
+## Supports Me
+Want to see more free, high-quality code and articles? Buy me a coffee and make it happen! 
+
+[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/syubban)