/vite-react-ts-scp-bp

Vite⚡ React Boilerplate (TypeScript + Styled Components 💅 + Polished✨ Edition)

Primary LanguageTypeScriptMIT LicenseMIT

Vite⚡ React TS Boilerplate (Styled Components💅 + Polished✨ Edition)

Features

  • ⚛️ Supports React + TypeScript
  • 🔥 Hot Module Replacement (HMR) (Dev mode)
  • 🖌️ Supports styling with CSS-in-JS
    • 💅 Styled Components
    • ✨ Polished
  • 🗜️ Minification of CSS/JS files (Prod mode)
  • 🖼 Optimization of images with ImageTools (Prod mode)
    • 🔁 Images can be converted to WEBP or AVIF formats (Prod mode)
  • ⭐ SVGR converts SVG into React components and inserts them as inline SVG into HTML.
  • 🧰 ESlint, Stylelint and Prettier
  • ⚙️ Support of environment variables (aka dotenv, built in Vite, VITE_ prefix is required.)

Scripts

To install dependencies:

yarn install

Start development mode:

yarn run start

Create production build:

yarn run build

Lint scripts:

yarn run lint:scripts

Lint styles:

yarn run lint:styles

Format code with Prettier:

yarn run lint:format