vite-web

A Tiny Vite Starter Template

Table of Contents

• About
• Features
• Folder Structure
• Requirements
• Setup
• Development
• Build
• Deploy
• More Info

📖 About

vite-web is a customizable template for modern web applications using Vite. It features out-of-the-box support for fast reloading and pre-configured linters, ensuring best practices and code consistency from the start.

🚀 Features

• Vite: Experience fast builds and updates with Vite's modern build tooling.
• ESLint: Pre-configured with eslint-config-manzdev for JavaScript linting.
• StyleLint: Integrated with stylelint-config-manzdev for CSS linting.
• GitHub Pages: Ready setup for deployment to gh-pages for easy preview and deployment.

📂 Folder Structure

├── jsconfig.json
├── package.json
├── public
├── README.md
├── src
│   ├── assets
│   ├── components
│   ├── index.css
│   ├── index.html
│   ├── index.js
│   └── modules
└── vite.config.js

⚙️ Requirements

Ensure you have Node.js installed on your machine.

💻 Setup

Clone this repository and navigate into the project folder:

git clone https://github.com/sanurb/vite-web
cd vite-project-template

Install dependencies:

npm install

Development

Start the development server:

npm run dev

Open http://localhost:5173 in your browser to see your application in action.

Build

To build the project for production:

npm run build

Deploy

Deploy your project to GitHub Pages:

npm run deploy

More Info

Source | Website