Skip to content
This repository has been archived by the owner on May 14, 2023. It is now read-only.

toggle-corp/base-vite-app

Repository files navigation

Features


Try it now!

GitHub Template

Create a repo from this template on GitHub

Clone to local

If you prefer to do it manually with a cleaner git history

npx degit toggle-corp/base-vite-app my-vite-app
cd my-vite-app
pnpm install

Checklist

When you use this template, try to follow the checklist to update your info properly

  • Modify or delete the LICENSE file
  • If you don't plan to use GitHub Actions, delete the .github directory
  • Change the favicon.png, apple-touch-icon.png, android-chrome-192x192.png, android-chrome-512x512.png, ms-icon-144x144.png and favicon.ico
  • Change the title, description, icon, apple touch icon, mask icon, ms application tile image, ms application tile color, and theme color in the index.html and vite.config.ts
  • Clean up the READMEs and remove routes
  • Change the name field in package.json

And, enjoy :)

Usage

Development

Run

pnpm dev

and visit http://localhost:5173

Build

To build the App, run

pnpm build

To preview the build

pnpm preview

Scripts

  • pnpm dev - start a development server with hot reload
  • pnpm build - build for production. The generated files will be in the dist folder
  • pnpm preview - locally preview the production build
  • pnpm test - run unit and integration tests related to changed files based on git
  • pnpm lint - runs ESLint
  • pnpm stylelint - runs Stylelint
  • pnpm typecheck - runs typescript type check