开源项目 fe-fwk-book 使用教程
1. 项目的目录结构及介绍
fe-fwk-book/
├── README.md
├── package.json
├── src/
│ ├── index.js
│ ├── components/
│ ├── utils/
│ └── ...
├── public/
│ ├── index.html
│ └── ...
├── tests/
│ ├── index.test.js
│ └── ...
└── ...
README.md
: 项目介绍和使用说明。package.json
: 项目依赖和脚本配置。src/
: 源代码目录,包含主要的JavaScript文件和组件。public/
: 静态资源目录,包含HTML文件和其他静态资源。tests/
: 测试文件目录,包含各种测试脚本。
2. 项目的启动文件介绍
项目的启动文件位于 src/index.js
。该文件主要负责初始化应用和挂载到DOM中。以下是 index.js
的基本结构:
import App from './App';
import { createRoot } from 'react-dom/client';
const root = createRoot(document.getElementById('root'));
root.render(<App />);
App
: 主应用组件。createRoot
: React 18 中的新API,用于创建根节点。document.getElementById('root')
: 获取HTML中的根节点元素。
3. 项目的配置文件介绍
项目的配置文件主要是 package.json
,它包含了项目的依赖、脚本和其他配置信息。以下是 package.json
的基本结构:
{
"name": "fe-fwk-book",
"version": "1.0.0",
"description": "Learn how frontend frameworks work by building your own",
"main": "src/index.js",
"scripts": {
"start": "react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test",
"eject": "react-scripts eject"
},
"dependencies": {
"react": "^18.0.0",
"react-dom": "^18.0.0",
"react-scripts": "5.0.0"
},
"devDependencies": {
"eslint": "^8.0.0",
"prettier": "^2.0.0"
},
"eslintConfig": {
"extends": "react-app"
},
"browserslist": {
"production": [
">0.2%",
"not dead",
"not op_mini all"
],
"development": [
"last 1 chrome version",
"last 1 firefox version",
"last 1 safari version"
]
}
}
name
: 项目名称。version
: 项目版本。description
: 项目描述。main
: 入口文件。scripts
: 可执行脚本。dependencies
: 生产环境依赖。devDependencies
: 开发环境依赖。eslintConfig
: ESLint 配置。browserslist
: 浏览器兼容性配置。