Quellcode durchsuchen

docs(README): 更新项目说明和结构

- 移除 Getting Started、Troubleshooting 等部分
- 新增项目结构说明- 新增分包说明和打包命令
- 整理部分方法类工具类
xuqm vor 5 Tagen
Ursprung
Commit
79c9efa54e
1 geänderte Dateien mit 34 neuen und 96 gelöschten Zeilen
  1. 34 96
      README.md

+ 34 - 96
README.md

@@ -1,97 +1,35 @@
-This is a new [**React Native**](https://reactnative.dev) project, bootstrapped using [`@react-native-community/cli`](https://github.com/react-native-community/cli).
-
-# Getting Started
-
-> **Note**: Make sure you have completed the [Set Up Your Environment](https://reactnative.dev/docs/set-up-your-environment) guide before proceeding.
-
-## Step 1: Start Metro
-
-First, you will need to run **Metro**, the JavaScript build tool for React Native.
-
-To start the Metro dev server, run the following command from the root of your React Native project:
-
-```sh
-# Using npm
-npm start
-
-# OR using Yarn
-yarn start
-```
-
-## Step 2: Build and run your app
-
-With Metro running, open a new terminal window/pane from the root of your React Native project, and use one of the following commands to build and run your Android or iOS app:
-
-### Android
-
-```sh
-# Using npm
-npm run android
-
-# OR using Yarn
-yarn android
-```
-
-### iOS
-
-For iOS, remember to install CocoaPods dependencies (this only needs to be run on first clone or after updating native deps).
-
-The first time you create a new project, run the Ruby bundler to install CocoaPods itself:
-
-```sh
-bundle install
-```
-
-Then, and every time you update your native dependencies, run:
-
-```sh
-bundle exec pod install
+# 1. 项目结构
+
+> - common:公共模块
+> - app:首页,基础应用
+> - miniapp
+>   - hospital: 互联网医院(下线)
+>   - ywq:医网签
+>   - ……:其它子应用(小程序)
+>
+
+# 2. 说明
+>   1. 下证等逻辑放在`common`里面
+>   2. 方法类工具类放在`common`里面
+>   3. 小程序共有的功能点,复用点放在`common`里面
+>   4. 避免`common`引用子级(app、miniapp),造成循环依赖
+> 
+
+# 3. 分包说明
+> 1. common和app模块在一个包里,miniapp在一个包里
+> 2. App启动时会默认加载第一个common包,点击进入小程序时,加载第二个包
+> 3. 打包命令如下:
+>    1. `build-android-common`:打基础common包
+>    2. `build-android-buz`:打业务包
+> 4. 先打基础包再打业务包,如果基础包没变化,不需要更新,就不要重新打包,避免无法和线上合并
+> 
+> 
+# 4. 部分方法类工具类整理
+### 4.1 Toast提示
+
+```ts
+import {showErrorMessage, showMessage} from "@common/ToastHelper";
+
+showMessage()
+showErrorMessage()
 ```
-
-For more information, please visit [CocoaPods Getting Started guide](https://guides.cocoapods.org/using/getting-started.html).
-
-```sh
-# Using npm
-npm run ios
-
-# OR using Yarn
-yarn ios
-```
-
-If everything is set up correctly, you should see your new app running in the Android Emulator, iOS Simulator, or your connected device.
-
-This is one way to run your app — you can also build it directly from Android Studio or Xcode.
-
-## Step 3: Modify your app
-
-Now that you have successfully run the app, let's make changes!
-
-Open `App.tsx` in your text editor of choice and make some changes. When you save, your app will automatically update and reflect these changes — this is powered by [Fast Refresh](https://reactnative.dev/docs/fast-refresh).
-
-When you want to forcefully reload, for example to reset the state of your app, you can perform a full reload:
-
-- **Android**: Press the <kbd>R</kbd> key twice or select **"Reload"** from the **Dev Menu**, accessed via <kbd>Ctrl</kbd> + <kbd>M</kbd> (Windows/Linux) or <kbd>Cmd ⌘</kbd> + <kbd>M</kbd> (macOS).
-- **iOS**: Press <kbd>R</kbd> in iOS Simulator.
-
-## Congratulations! :tada:
-
-You've successfully run and modified your React Native App. :partying_face:
-
-### Now what?
-
-- If you want to add this new React Native code to an existing application, check out the [Integration guide](https://reactnative.dev/docs/integration-with-existing-apps).
-- If you're curious to learn more about React Native, check out the [docs](https://reactnative.dev/docs/getting-started).
-
-# Troubleshooting
-
-If you're having issues getting the above steps to work, see the [Troubleshooting](https://reactnative.dev/docs/troubleshooting) page.
-
-# Learn More
-
-To learn more about React Native, take a look at the following resources:
-
-- [React Native Website](https://reactnative.dev) - learn more about React Native.
-- [Getting Started](https://reactnative.dev/docs/environment-setup) - an **overview** of React Native and how setup your environment.
-- [Learn the Basics](https://reactnative.dev/docs/getting-started) - a **guided tour** of the React Native **basics**.
-- [Blog](https://reactnative.dev/blog) - read the latest official React Native **Blog** posts.
-- [`@facebook/react-native`](https://github.com/facebook/react-native) - the Open Source; GitHub **repository** for React Native.