Vite Boilerplate 项目教程

Vite Boilerplate 项目教程

vite-boilerplateThis boilerplate contains all the tools you need to build a modern web app with TypeScript, React, Vite, Storybook and Express.项目地址:https://gitcode.com/gh_mirrors/vi/vite-boilerplate

1. 项目的目录结构及介绍

vite-boilerplate/
├── public/
│   └── index.html
├── src/
│   ├── assets/
│   ├── components/
│   ├── pages/
│   ├── App.tsx
│   ├── index.tsx
│   └── ...
├── .eslintrc.js
├── .gitignore
├── .prettierrc
├── package.json
├── tsconfig.json
├── vite.config.ts
└── ...

• public/: 存放静态文件，如 index.html。
• src/: 项目的主要源代码目录。
  • assets/: 存放静态资源，如图片、字体等。
  • components/: 存放React组件。
  • pages/: 存放页面组件。
  • App.tsx: 主应用组件。
  • index.tsx: 入口文件。
• .eslintrc.js: ESLint配置文件。
• .gitignore: Git忽略文件配置。
• .prettierrc: Prettier代码格式化配置。
• package.json: 项目依赖和脚本配置。
• tsconfig.json: TypeScript配置文件。
• vite.config.ts: Vite配置文件。

2. 项目的启动文件介绍

• src/index.tsx: 这是项目的入口文件，负责渲染React应用到DOM中。

import React from 'react';
import ReactDOM from 'react-dom';
import App from './App';

ReactDOM.render(
  <React.StrictMode>
    <App />
  </React.StrictMode>,
  document.getElementById('root')
);

3. 项目的配置文件介绍

• vite.config.ts: Vite的配置文件，包含项目的基本配置和插件配置。

import { defineConfig } from 'vite';
import react from '@vitejs/plugin-react';

export default defineConfig({
  plugins: [react()],
  server: {
    port: 3000,
  },
  build: {
    outDir: 'dist',
  },
});

• .eslintrc.js: ESLint的配置文件，用于代码风格和质量检查。

module.exports = {
  extends: ['eslint:recommended', 'plugin:react/recommended'],
  parserOptions: {
    ecmaVersion: 2021,
    sourceType: 'module',
    ecmaFeatures: {
      jsx: true,
    },
  },
  rules: {
    // 自定义规则
  },
};

• tsconfig.json: TypeScript的配置文件，用于TypeScript编译选项。

{
  "compilerOptions": {
    "target": "esnext",
    "module": "esnext",
    "moduleResolution": "node",
    "strict": true,
    "jsx": "preserve",
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src"]
}

以上是Vite Boilerplate项目的基本教程，涵盖了目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你快速上手和理解项目。

vite-boilerplateThis boilerplate contains all the tools you need to build a modern web app with TypeScript, React, Vite, Storybook and Express.项目地址:https://gitcode.com/gh_mirrors/vi/vite-boilerplate