ramniel / react-ts-vite-tailwind-template

App template using Vite, React, TypeScript and TailwindCSS

Vite + React + TypeScript + TailwindCSS

App template using Vite, React, TypeScript and TailwindCSS

Motivation

Lightning-fast startups with instant hot module replacement and complex responsive layout creation using Vite, React, TypeScript, and TailwindCSS.

This starter uses following libraries:

• Vite
• React
  • React Router DOM
• TypeScript
• TailwindCSS
  • daisyUI
• ESLint
• Prettier

Set up

mv .env.local.example .env.local
yarn
yarn dev

Vite

Vite is a fast frontend build tool.

React

React is a JavaScript library for building user interfaces.

React Router DOM

React Router DOM is an npm package that enables you to implement dynamic routing in a web app.

TypeScript

TypeScript is a superset of JavaScript. It is just one of NPM library, but it provides an original compiler.

When you use TypeScript with React, you can write JSX with TypeScript, called TSX. Then you can develop views written by Type-Safe template.

Tailwind CSS

Tailwind CSS is modern utility-first CSS framework. It provides many CSS rules, but these are purged when production builds. So developers do not worry about CSS asset size for performance optimization.

daisyUI

daisyUI is Tailwind CSS Components library.

If you don't want to use it, just remove the package and remove config in tailwind.config.js.

Formatter and Linter

Already set up ESLint and Prettier. You can customize the rules.

How was it builded?

• Create Vite app for React with TypeScript
  Run yarn create vite react-ts-vite-tailwindcss-template --template react-ts
  

• Add TailwindCSS
  Run yarn add --dev tailwindcss postcss autoprefixer
  

• Configure TailwindCSS
  Run npx tailwindcss init
  

• Add the following in postcss.config.js file:
  

  module.exports = {
    plugins: {
      tailwindcss: {},
      autoprefixer: {},
    },
  };

• Update content in tailwind.config.js:
  

  module.exports = {
    //...
    content: ['./index.html', './src/**/*.{tsx,ts}'],
    //...
  };

• Add daisyUI
  

  • Run yarn add daisyui
    

  • Then add daisyUI to tailwind.config.js file:
    

    module.exports = {
      //...
      plugins: [require('daisyui')],
    };

• Add support for TypeScript's path mapping in Vite
  

  • Run yarn add --dev vite-tsconfig-paths

• Add ESLint
  

  • Run yarn add --dev eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin
    

  • Configure ESLint

    • Run npx eslint --init

      ✔ How would you like to use ESLint? · style
      ✔ What type of modules does your project use? · esm
      ✔ Which framework does your project use? · react
      ✔ Does your project use TypeScript? · No / Yes · Yes
      ✔ Where does your code run? · browser
      ✔ How would you like to define a style for your project? · guide
      ✔ Which style guide do you want to follow? · standard
      ✔ What format do you want your config file to be in? · JavaScript
      ✔ Do you want to downgrade? · No / Yes · No
      ✔ Would you like to install them now with npm? · No / Yes · No
      

    • Run yarn add --dev eslint-config-standard eslint-plugin-import eslint-plugin-node eslint-plugin-promise eslint-plugin-react
      

    • Adding some rules in .eslintrc.js:

      rules: {
        'react/jsx-curly-brace-presence': 'error',
        'react/react-in-jsx-scope': 'off',
        'react/self-closing-comp': [
          'error',
          {
            component: true,
            html: true,
          },
        ],
        'react/jsx-boolean-value': 'error',
        'prefer-template': 'error',
        'jsx-quotes': ['error', 'prefer-double'],
        'react/jsx-tag-spacing': 'error',
      }

    • Create .eslintignore file and add the following:
      node_modules
dist
      

    • Add the following in package.json:

      "scripts": {
        // ...
        "lint": "eslint --ignore-path .eslintignore --ext .js,.ts,.tsx ."
      }

      
      

      To automatically fix all errors, run:
      yarn lint --fix

      Some useful VSCode extension
      

      • ESLint

      • Error Lens

• Add Prettier
  

  • Run yarn add --dev prettier
    

  • Create .prettierrc.js file and add the following:

    module.exports = {
      printWidth: 120,
      singleQuote: true,
    };

  • Add the following in package.json:

    "scripts": {
      // ...
      "format": "prettier --ignore-path .gitignore --write \"**/*.+(js|ts|json)\""
    }

    
    

• Add React Router Dom
  

  • Run yarn add [email protected]