开源项目 frontend
使用教程
1. 项目的目录结构及介绍
frontend/
├── src/
│ ├── assets/ # 存放静态资源,如图片、字体等
│ ├── components/ # 存放可复用的组件
│ ├── pages/ # 存放页面组件
│ ├── styles/ # 存放全局样式文件
│ ├── App.js # 主应用组件
│ └── index.js # 入口文件
├── public/
│ ├── index.html # HTML模板文件
│ └── favicon.ico # 网站图标
├── package.json # 项目依赖和脚本配置
├── README.md # 项目说明文档
└── .env # 环境变量配置文件
2. 项目的启动文件介绍
index.js
index.js
是项目的入口文件,负责初始化应用并挂载到 HTML 模板中。以下是 index.js
的主要内容:
import React from 'react';
import ReactDOM from 'react-dom';
import App from './App';
ReactDOM.render(<App />, document.getElementById('root'));
App.js
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
文件包含了项目的依赖、脚本和其他配置信息。以下是 package.json
的部分内容:
{
"name": "frontend",
"version": "1.0.0",
"scripts": {
"start": "react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test",
"eject": "react-scripts eject"
},
"dependencies": {
"react": "^17.0.2",
"react-dom": "^17.0.2",
"react-router-dom": "^5.2.0"
},
"devDependencies": {
"eslint": "^7.23.0",
"prettier": "^2.2.1"
}
}
.env
.env
文件用于配置环境变量,例如 API 地址、密钥等。以下是 .env
文件的示例内容:
REACT_APP_API_URL=http://localhost:3000
REACT_APP_SECRET_KEY=your_secret_key
在代码中可以通过 process.env.REACT_APP_API_URL
和 process.env.REACT_APP_SECRET_KEY
来访问这些环境变量。