第一步:准备探险工具——下载Node.js
首先,你需要准备一把探险工具——Node.js。Node.js是一个允许你使用JavaScript运行在服务器端的运行环境。你可以从Node.js官网下载适合你操作系统的版本。
# 在命令行中运行以下命令来安装Node.js
curl -fsSL https://deb.nodesource.com/setup_16.x | bash -
sudo apt-get install -y nodejs
第二步:搭建探险基地——初始化项目
安装完Node.js后,你需要一个基地来搭建你的探险项目。使用以下命令在你的工作目录中创建一个新的文件夹,并初始化一个React项目。
mkdir moon-exploration
cd moon-exploration
npx create-react-app . --template typescript
这个命令会创建一个名为moon-exploration的文件夹,并在其中初始化一个新的React项目,同时使用TypeScript。
第三步:探索React框架——了解项目结构
打开项目文件夹,你可以看到以下结构:
moon-exploration/
├── node_modules/
├── public/
│ ├── index.html
│ └── ...
├── src/
│ ├── api/
│ ├── components/
│ ├── hooks/
│ ├── pages/
│ ├── App.tsx
│ └── ...
├── tsconfig.json
├── package.json
└── ...
这个结构可以帮助你更好地理解React项目的组成部分。
第四步:搭建探险基地——安装依赖
在你的项目目录中,使用以下命令安装项目所需的依赖。
cd moon-exploration
npm install
第五步:编写探险日志——创建组件
在src/components目录下创建一个新的组件,比如MoonExploration.tsx。
// src/components/MoonExploration.tsx
import React from 'react';
const MoonExploration: React.FC = () => {
return (
<div>
<h1>月球探险家日志</h1>
<p>记录你的探险旅程...</p>
</div>
);
};
export default MoonExploration;
第六步:记录探险历程——使用状态管理
在src/pages目录下创建一个页面组件,比如Home.tsx。
// src/pages/Home.tsx
import React, { useState } from 'react';
import MoonExploration from '../components/MoonExploration';
const Home: React.FC = () => {
const [log, setLog] = useState<string>('');
const addLog = (newLog: string) => {
setLog(`${log}\n${newLog}`);
};
return (
<div>
<h1>月球探险家日志</h1>
<MoonExploration log={log} />
<button onClick={() => addLog('今天我看到了月球的另一面!')}>添加日志</button>
</div>
);
};
export default Home;
第七步:探险导航——配置路由
安装react-router-dom来配置你的导航。
npm install react-router-dom
在src/App.tsx中配置路由。
// src/App.tsx
import React from 'react';
import { BrowserRouter as Router, Route, Switch } from 'react-router-dom';
import Home from './pages/Home';
const App: React.FC = () => {
return (
<Router>
<Switch>
<Route path="/" exact component={Home} />
{/* 更多路由配置 */}
</Switch>
</Router>
);
};
export default App;
第八步:探险装备——使用Context API
使用Context API来共享状态,比如探险日志。
// src/context/LogContext.tsx
import React, { createContext, useState } from 'react';
export const LogContext = createContext({
log: '',
addLog: () => {},
});
export const LogProvider: React.FC = ({ children }) => {
const [log, setLog] = useState<string>('');
const addLog = (newLog: string) => {
setLog(`${log}\n${newLog}`);
};
return (
<LogContext.Provider value={{ log, addLog }}>
{children}
</LogContext.Provider>
);
};
在src/App.tsx中包裹你的应用。
// src/App.tsx
import React from 'react';
import { BrowserRouter as Router, Route, Switch } from 'react-router-dom';
import Home from './pages/Home';
import { LogProvider } from './context/LogContext';
const App: React.FC = () => {
return (
<LogProvider>
<Router>
<Switch>
<Route path="/" exact component={Home} />
{/* 更多路由配置 */}
</Switch>
</Router>
</LogProvider>
);
};
export default App;
第九步:探险装备——使用Redux
如果你需要更复杂的状态管理,可以考虑使用Redux。
npm install redux react-redux
创建一个Redux store,并在src/store目录下创建index.ts。
// src/store/index.ts
import { createStore } from 'redux';
import rootReducer from './reducers';
const store = createStore(rootReducer);
export default store;
创建一个action和reducer来管理日志。
// src/store/reducers/logReducer.ts
const initialState = {
log: '',
};
export const addLog = (newLog: string) => ({
type: 'ADD_LOG',
payload: newLog,
});
export const logReducer = (state = initialState, action) => {
switch (action.type) {
case 'ADD_LOG':
return {
...state,
log: `${state.log}\n${action.payload}`,
};
default:
return state;
}
};
在src/store/reducers目录下创建index.ts来组合所有的reducers。
// src/store/reducers/index.ts
import { combineReducers } from 'redux';
import logReducer from './logReducer';
export default combineReducers({
log: logReducer,
});
在src/App.tsx中连接Redux store。
// src/App.tsx
import React from 'react';
import { BrowserRouter as Router, Route, Switch } from 'react-router-dom';
import { Provider } from 'react-redux';
import { createStore } from 'redux';
import rootReducer from './store/reducers';
import Home from './pages/Home';
const store = createStore(rootReducer);
const App: React.FC = () => {
return (
<Provider store={store}>
<Router>
<Switch>
<Route path="/" exact component={Home} />
{/* 更多路由配置 */}
</Switch>
</Router>
</Provider>
);
};
export default App;
第十步:探险导航——使用Redux-Router
如果你想在Redux中管理路由状态,可以使用Redux-Router。
npm install redux-router react-router-redux
配置你的路由和Redux store。
// src/store/reducers/routerReducer.ts
import { connectRouter } from 'connected-react-router';
import { createBrowserHistory } from 'history';
const history = createBrowserHistory();
export const routerReducer = connectRouter(history);
export default routerReducer;
在src/store/reducers目录下创建index.ts来组合所有的reducers。
// src/store/reducers/index.ts
import { combineReducers } from 'redux';
import logReducer from './logReducer';
import routerReducer from './routerReducer';
export default combineReducers({
log: logReducer,
router: routerReducer,
});
在src/App.tsx中连接Redux store和Redux-Router。
// src/App.tsx
import React from 'react';
import { BrowserRouter as Router, Route, Switch } from 'react-router-dom';
import { Provider } from 'react-redux';
import { createStore } from 'redux';
import rootReducer from './store/reducers';
import Home from './pages/Home';
const store = createStore(rootReducer);
const App: React.FC = () => {
return (
<Provider store={store}>
<Router>
<Switch>
<Route path="/" exact component={Home} />
{/* 更多路由配置 */}
</Switch>
</Router>
</Provider>
);
};
export default App;
第十一步:探险装备——使用Redux Toolkit
Redux Toolkit可以帮助你简化Redux的开发。
npm install @reduxjs/toolkit react-redux
创建一个store配置文件。
// src/store/configureStore.ts
import { configureStore } from '@reduxjs/toolkit';
import logReducer from './reducers/logReducer';
export const store = configureStore({
reducer: {
log: logReducer,
},
});
在src/App.tsx中连接Redux store。
// src/App.tsx
import React from 'react';
import { BrowserRouter as Router, Route, Switch } from 'react-router-dom';
import { Provider } from 'react-redux';
import store from './store/configureStore';
import Home from './pages/Home';
const App: React.FC = () => {
return (
<Provider store={store}>
<Router>
<Switch>
<Route path="/" exact component={Home} />
{/* 更多路由配置 */}
</Switch>
</Router>
</Provider>
);
};
export default App;
第十二步:探险装备——使用TypeScript
使用TypeScript可以帮助你更好地管理类型。
npm install @types/react @types/node @types/react-router-dom @types/react-redux @types/jest
在你的tsconfig.json中配置TypeScript。
{
"compilerOptions": {
"target": "es5",
"module": "commonjs",
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"forceConsistentCasingInFileNames": true,
"outDir": "./dist",
"rootDir": "./src",
"moduleResolution": "node",
"jsx": "react",
"types": ["node", "react", "react-router-dom", "react-redux", "jest"]
},
"include": ["src/**/*"],
"exclude": ["node_modules"]
}
第十三步:探险装备——使用Jest
使用Jest来编写测试。
npm install --save-dev jest @testing-library/react @testing-library/jest-dom
创建一个测试文件。
// src/pages/Home.test.tsx
import React from 'react';
import { render, screen } from '@testing-library/react';
import Home from './Home';
test('renders Home component', () => {
render(<Home />);
const linkElement = screen.getByText(/月球探险家日志/i);
expect(linkElement).toBeInTheDocument();
});
在package.json中配置测试脚本。
"scripts": {
"test": "jest"
}
运行测试。
npm test
第十四步:探险装备——使用Storybook
使用Storybook来编写UI组件文档。
npm install --save-dev @storybook/react @storybook/addon-links @storybook/addon-essentials
在package.json中配置Storybook脚本。
"scripts": {
"start-storybook": "start-storybook -p 6006",
"build-storybook": "build-storybook -c .storybook"
}
运行Storybook。
npm start-storybook
在.storybook/main.js中配置你的Storybook。
// .storybook/main.js
import { configure } from '@storybook/react';
configure(() => {
require('./src/stories');
}, module);
在src/stories目录下创建你的组件故事。
// src/stories/MoonExploration.stories.tsx
import React from 'react';
import { storiesOf } from '@storybook/react';
import MoonExploration from '../components/MoonExploration';
storiesOf('MoonExploration', module).add('Default', () => <MoonExploration />);
第十五步:探险装备——使用ESLint
使用ESLint来检查代码质量。
npm install --save-dev eslint eslint-plugin-react
在.eslintrc中配置ESLint规则。
{
"extends": "eslint:recommended",
"plugins": ["react"],
"rules": {
"react/jsx-filename-extension": ["error", { "extensions": [".tsx"] }],
"react/prop-types": "off",
},
}
在package.json中配置ESLint脚本。
"scripts": {
"lint": "eslint src --ext .ts"
}
运行ESLint。
npm run lint
第十六步:探险装备——使用Prettier
使用Prettier来格式化代码。
npm install --save-dev prettier eslint-config-prettier eslint-plugin-prettier
在.eslintrc中配置Prettier。
{
"extends": ["eslint:recommended", "plugin:prettier/recommended"],
"plugins": ["prettier"],
"rules": {
"prettier/prettier": "error",
},
}
在package.json中配置Prettier脚本。
"scripts": {
"format": "prettier --write ."
}
运行Prettier。
npm run format
第十七步:启程探险——部署你的React应用
最后,你需要将你的React应用部署到服务器上。
npm run build
这将在public目录下生成一个静态的HTML文件。然后,你可以将这个文件部署到任何支持静态文件的服务器上,比如GitHub Pages、Netlify或Vercel。
恭喜你,你已经完成了17步的React框架安装,现在你可以开始你的月球探险之旅了!
