Skip to content

Commit e3224fe

Browse files
author
perlinson
committed
更新readme
1 parent bbe9b99 commit e3224fe

1 file changed

Lines changed: 88 additions & 13 deletions

File tree

README.md

Lines changed: 88 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,16 @@ Modern React state management framework with concurrent features and modern tool
2121

2222
### 📦 Monorepo Architecture
2323
- **modernx**: Main package with all features
24-
- **modernx-core**: Core functionality
25-
- **modernx-immer**: Immer integration
24+
- **modernx-core**: Core functionality and React integration
25+
- **modernx-immer**: Immer integration for immutable updates
2626
- **modernx-loading**: Loading state management
27+
- **modernx-logger**: Redux logger plugin
28+
- **modernx-cli**: Command-line tools and scaffolding
29+
- **modernx-gui**: Development GUI and debugging tools
2730

2831
### 🛠️ Developer Experience
29-
- **TypeScript Ready**: Full TypeScript support with type definitions
32+
- **Full TypeScript Support**: Complete TypeScript support with type definitions and ESLint integration
33+
- **Code Quality**: ESLint + @typescript-eslint + Prettier for consistent code style
3034
- **Zero Configuration**: Out of the box with sensible defaults
3135
- **Modern Toolchain**: Built with Node.js 18, latest Babel, and modern build tools
3236
- **Hot Reload**: Development experience with HMR
@@ -118,6 +122,69 @@ export default connect(
118122

119123
---
120124

125+
## 🛠️ Development
126+
127+
### Contributing
128+
129+
We welcome contributions! Please see our [Developer Guide](./docs/DEVELOPER_GUIDE.md) for detailed instructions.
130+
131+
### Quick Setup
132+
133+
```bash
134+
# Clone the repository
135+
git clone https://github.com/perlinson/modernx.git
136+
cd modernx
137+
138+
# Install dependencies
139+
npm install
140+
141+
# Bootstrap packages
142+
npm run bootstrap
143+
144+
# Link development dependencies
145+
npm run dev:link
146+
147+
# Start development
148+
npm run dev
149+
```
150+
151+
### Development Commands
152+
153+
```bash
154+
# Build all packages
155+
npm run build
156+
157+
# Run tests
158+
npm test
159+
160+
# Type checking
161+
npm run typecheck
162+
163+
# Lint code
164+
npm run lint
165+
166+
# Validate monorepo
167+
npm run validate:quick
168+
```
169+
170+
### Monorepo Management
171+
172+
```bash
173+
# Workspace status
174+
npm run workspaces:status
175+
176+
# Link internal dependencies
177+
npm run dev:link
178+
179+
# Clean all packages
180+
npm run clean:all
181+
182+
# Run scripts across packages
183+
npm run run:all build
184+
```
185+
186+
---
187+
121188
## 🛠️ Development Tools
122189

123190
### Logger Plugin
@@ -224,11 +291,11 @@ const SearchComponent = () => {
224291
## 📚 Documentation
225292

226293
### Guides
227-
- [Installation Guide](./docs/GUIDE.md#installation)
228-
- [Quick Start](./docs/GUIDE.md#quick-start)
229-
- [Core Concepts](./docs/GUIDE.md#core-concepts)
230-
- [React 18 Features](./docs/GUIDE.md#react-18-features)
231-
- [Advanced Usage](./docs/GUIDE.md#advanced-usage)
294+
- [Installation Guide](./docs/GettingStarted.md#installation)
295+
- [Quick Start](./docs/GettingStarted.md#quick-start)
296+
- [Core Concepts](./docs/Concepts.md)
297+
- [React 18 Features](./docs/GettingStarted.md#react-18-features)
298+
- [Advanced Usage](./docs/GettingStarted.md#advanced-usage)
232299

233300
### API Reference
234301
- [createApp](./docs/API.md#createapp)
@@ -238,9 +305,10 @@ const SearchComponent = () => {
238305

239306
### Examples
240307
- [Basic Counter](./examples/with-basic)
241-
- [Todo List](./examples/with-todo)
242-
- [Async Data](./examples/with-async)
243-
- [TypeScript](./examples/with-typescript)
308+
- [Todo List](./examples/user-dashboard)
309+
- [Async Data](./examples/with-basic)
310+
- [React 18 Concurrent](./examples/react18-concurrent)
311+
- [React Router v6](./examples/react-router-v6)
244312

245313
---
246314

@@ -252,9 +320,13 @@ modernx/
252320
│ ├── modernx/ # Main package
253321
│ ├── modernx-core/ # Core functionality
254322
│ ├── modernx-immer/ # Immer integration
255-
│ └── modernx-loading/ # Loading state
323+
│ ├── modernx-loading/ # Loading state
324+
│ ├── modernx-logger/ # Logger plugin
325+
│ ├── modernx-cli/ # Command-line tools
326+
│ └── modernx-gui/ # Development GUI
256327
├── examples/ # Example projects
257328
├── docs/ # Documentation
329+
├── website/ # VuePress website
258330
└── scripts/ # Build and deployment scripts
259331
```
260332

@@ -305,12 +377,15 @@ npm run test:modernx-core
305377
| [modernx-core](https://www.npmjs.com/package/modernx-core) | ![npm version](https://img.shields.io/npm/v/modernx-core.svg) | ~27KB | Core functionality |
306378
| [modernx-immer](https://www.npmjs.com/package/modernx-immer) | ![npm version](https://img.shields.io/npm/v/modernx-immer.svg) | ~2KB | Immer integration |
307379
| [modernx-loading](https://www.npmjs.com/package/modernx-loading) | ![npm version](https://img.shields.io/npm/v/modernx-loading.svg) | ~5KB | Loading state management |
380+
| [modernx-logger](https://www.npmjs.com/package/modernx-logger) | ![npm version](https://img.shields.io/npm/v/modernx-logger.svg) | ~3KB | Redux logger plugin |
381+
| [modernx-cli](https://www.npmjs.com/package/modernx-cli) | ![npm version](https://img.shields.io/npm/v/modernx-cli.svg) | ~8KB | Command-line tools |
382+
| [modernx-gui](https://www.npmjs.com/package/modernx-gui) | ![npm version](https://img.shields.io/npm/v/modernx-gui.svg) | ~12KB | Development GUI |
308383

309384
---
310385

311386
## 🤝 Contributing
312387

313-
We welcome all kinds of contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) for details.
388+
We welcome all kinds of contributions! Please see our [Developer Guide](./docs/DEVELOPER_GUIDE.md) for details.
314389

315390
### Development Workflow
316391

0 commit comments

Comments
 (0)