React Pages Boilerplate 项目使用教程

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

react-pages-boilerplate/
├── public/
│   ├── index.html
│   └── favicon.ico
├── src/
│   ├── assets/
│   ├── components/
│   ├── pages/
│   ├── styles/
│   ├── App.js
│   ├── index.js
│   └── routes.js
├── .gitignore
├── package.json
├── README.md
└── webpack.config.js

目录结构介绍

• public/: 存放静态资源文件，如 index.html 和 favicon.ico。
• src/: 项目的源代码目录。
  • assets/: 存放图片、字体等静态资源。
  • components/: 存放 React 组件。
  • pages/: 存放页面组件。
  • styles/: 存放样式文件。
  • App.js: 项目的根组件。
  • index.js: 项目的入口文件。
  • routes.js: 路由配置文件。
• .gitignore: Git 忽略文件配置。
• package.json: 项目的依赖和脚本配置。
• README.md: 项目的说明文档。
• webpack.config.js: Webpack 配置文件。

2. 项目的启动文件介绍

index.js

index.js 是项目的入口文件，负责初始化 React 应用并挂载到 DOM 节点上。

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

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

App.js

App.js 是项目的根组件，通常包含路由配置和全局状态管理。

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

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

export default App;

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的依赖、脚本命令和其他元数据。

{
  "name": "react-pages-boilerplate",
  "version": "1.0.0",
  "scripts": {
    "start": "webpack-dev-server --config webpack.config.js --open",
    "build": "webpack --config webpack.config.js"
  },
  "dependencies": {
    "react": "^17.0.2",
    "react-dom": "^17.0.2",
    "react-router-dom": "^5.2.0"
  },
  "devDependencies": {
    "webpack": "^5.36.2",
    "webpack-cli": "^4.6.0",
    "webpack-dev-server": "^3.11.2"
  }
}

webpack.config.js

webpack.config.js 是 Webpack 的配置文件，定义了如何打包和构建项目。

const path = require('path');

module.exports = {
  entry: './src/index.js',
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: 'bundle.js'
  },
  module: {
    rules: [
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: 'babel-loader'
        }
      }
    ]
  },
  devServer: {
    contentBase: path.resolve(__dirname, 'public'),
    port: 3000
  }
};

以上是 react-pages-boilerplate 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助！