|
|
@@ -1,46 +1,61 @@
|
|
|
-# Getting Started with Create React App
|
|
|
+# Milvus insight client
|
|
|
|
|
|
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
|
|
|
+## How to run
|
|
|
|
|
|
-## Available Scripts
|
|
|
+1. yarn install
|
|
|
+2. yarn start
|
|
|
|
|
|
-In the project directory, you can run:
|
|
|
+## Folder Structure
|
|
|
|
|
|
-### `yarn start`
|
|
|
+ └── public # Static resources
|
|
|
+ └── src
|
|
|
+ ├── assets # Put images here
|
|
|
+ ├── components # Components
|
|
|
+ ├── consts # Constant values
|
|
|
+ ├── context # React context
|
|
|
+ ├── hooks # React hooks
|
|
|
+ ├── http # Http request api. And we have http interceptor in GlobalEffect.tsx file
|
|
|
+ ├── i18n # Language i18n
|
|
|
+ ├── pages # All pages , business components and types.
|
|
|
+ ├── router # React router, control the page auth.
|
|
|
+ ├── styles # Styles, normally we use material to control styles.
|
|
|
+ ├── types # Global types
|
|
|
+ └── utils # The common functoins
|
|
|
|
|
|
-Runs the app in the development mode.\
|
|
|
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
|
|
|
+### How to name the file
|
|
|
|
|
|
-The page will reload if you make edits.\
|
|
|
-You will also see any lint errors in the console.
|
|
|
+We use Camel-Case to name the file.
|
|
|
|
|
|
-### `yarn test`
|
|
|
+In components / pages folder, we need subfolder to wrapper all related files.
|
|
|
|
|
|
-Launches the test runner in the interactive watch mode.\
|
|
|
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
|
|
|
+### Global Effect
|
|
|
|
|
|
-### `yarn build`
|
|
|
+We get global data or take global side effect in components/layout/GlobalEffect
|
|
|
|
|
|
-Builds the app for production to the `build` folder.\
|
|
|
-It correctly bundles React in production mode and optimizes the build for the best performance.
|
|
|
+### Http request
|
|
|
|
|
|
-The build is minified and the filenames include the hashes.\
|
|
|
-Your app is ready to be deployed!
|
|
|
+We support user to define HOST_URL when docker run and it will write the env-config.js in public folder.
|
|
|
|
|
|
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
|
|
|
+We use class getter to define our client fields like \_field, because of our server response fields may be changed.
|
|
|
|
|
|
-### `yarn eject`
|
|
|
+### Helper Folder
|
|
|
|
|
|
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
|
|
|
+Like utils / consts / utils / hooks , we dont want put all functions or datas in one file like index.ts because of maintainability.
|
|
|
|
|
|
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
|
|
|
+So when we need to create new file , treat the file like Class then name it.
|
|
|
|
|
|
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
|
|
|
+### Icon
|
|
|
|
|
|
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
|
|
|
+We put all icons in components/icons file. Normally we use material icon.
|
|
|
|
|
|
-## Learn More
|
|
|
+If we use custom svg, like: import { ReactComponent as MilvusEmIcon } from xxx/xxx.svg'.
|
|
|
|
|
|
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
|
|
|
+It's react component because of svgr/webpack in webpack config.
|
|
|
|
|
|
-To learn React, check out the [React documentation](https://reactjs.org/).
|
|
|
+### Build
|
|
|
+
|
|
|
+We use react-app-rewired to change webpack config.
|
|
|
+
|
|
|
+If we want to change the webpack config, we can edit config-overrides.js file.
|
|
|
+
|
|
|
+And we use milvus insight server to host our client site. So our build path is `../server/build` .
|
Tumao