Development Guide

Table of Contents

1. Directory Explanation
2. Supplementary components
3. Supplementary feature
4. Open Source Library Description

Installing Dependencies

npm i
# or
yarn

Starting the Project

npm run dev
# or
yarn dev

Deployment

Building

npm run build
# or
yarn build

Directory Explanation

1. /page - Stores pages.
2. /components - Stores components.
3. /constants - Stores constants and enumerations.
4. /plugins - Stores plugins and library-related files.
5. /utils - Stores utility methods.
6. /assets - Stores static resources.
7. /http - Stores HTTP-related files such as request entry points, request hooks, file uploads, image transfers, etc.
8. global.scss - Stores global styles.
9. app.tsx - Runtime configuration, details can be found in the Umi documentation.

Supplementary components

1. Form, based on Formik
2. Table, based on rc-table
3. Cascader
4. Date Range Picker
5. MarkdownRender
6. CodeRender
7. Loading
8. Confirm Modal
9. Alert Message

Supplementary feature

1. Integrated natur state management, ready to use out of the box.
2. Integrated permission functionality, ready to use out of the box.
3. Integrated global loading and message prompt, ready to use out of the box.
4. Integrated login verification logic.
5. Provided a pre-configured axios request library, ready to use out of the box.

Open Source Library Description

1. UI library mui
2. State management natur
3. Event management rxjs
4. Basic utility functions lodash
5. Form validation component formik
6. Data validation tool yup
7. URL utility qs
8. Calculation library decimal.js
9. Color processing library color
10. Date and time processing library dayjs