TDesign React Starter 项目教程

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

TDesign React Starter 项目的目录结构如下：

tdesign-react-starter/
├── docs/
├── mock/
├── public/
├── src/
│   ├── assets/
│   ├── components/
│   ├── pages/
│   ├── styles/
│   ├── App.jsx
│   ├── index.jsx
│   └── ...
├── .editorconfig
├── .env
├── .env.development
├── .env.site
├── .eslintignore
├── .eslintrc.js
├── .gitignore
├── .prettierrc.js
├── LICENSE
├── README-zh_CN.md
├── README.md
├── index.html
├── package.json
├── tsconfig.json
└── vite.config.js

目录介绍

• docs/: 存放项目文档。
• mock/: 存放模拟数据。
• public/: 存放公共资源文件。
• src/: 源代码目录。
  • assets/: 存放静态资源，如图片、字体等。
  • components/: 存放可复用的组件。
  • pages/: 存放页面组件。
  • styles/: 存放全局样式文件。
  • App.jsx: 应用的根组件。
  • index.jsx: 项目的入口文件。
• .editorconfig: 编辑器配置文件。
• .env: 环境变量配置文件。
• .env.development: 开发环境变量配置文件。
• .env.site: 站点环境变量配置文件。
• .eslintignore: ESLint 忽略配置文件。
• .eslintrc.js: ESLint 配置文件。
• .gitignore: Git 忽略配置文件。
• .prettierrc.js: Prettier 配置文件。
• LICENSE: 开源协议文件。
• README-zh_CN.md: 中文 README 文件。
• README.md: 英文 README 文件。
• index.html: 项目的主 HTML 文件。
• package.json: 项目的依赖管理文件。
• tsconfig.json: TypeScript 配置文件。
• vite.config.js: Vite 配置文件。

2. 项目的启动文件介绍

入口文件

• src/index.jsx: 这是项目的入口文件，负责渲染根组件并挂载到 HTML 的根元素上。

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

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

根组件

• src/App.jsx: 这是应用的根组件，负责组织和渲染其他组件。

import React from 'react';
import { BrowserRouter as Router, Route, Switch } from 'react-router-dom';
import Home from './pages/Home';
import About from './pages/About';

function App() {
  return (
    <Router>
      <Switch>
        <Route exact path="/" component={Home} />
        <Route path="/about" component={About} />
      </Switch>
    </Router>
  );
}

export default App;

3. 项目的配置文件介绍

Vite 配置文件

• vite.config.js: 这是 Vite 的配置文件，用于配置开发服务器、构建选项等。

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

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

ESLint 配置文件

• .eslintrc.js: 这是 ESLint 的配置文件，用于配置代码规范。

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