Development Server Guide
This guide covers setting up and using the development server for AG Grid.
Starting the Dev Server
yarn nx dev
This starts the development server with hot-reload support for:
- Documentation site
- Grid source code changes
- Example updates
Build Watch Status
Monitor build health via the status file:
node_modules/.cache/ag-watch-status.json
This file contains:
- Current build state (building/ready/error)
- Package build status
- Error details if any
Common Tasks
Viewing Documentation Locally
After starting yarn nx dev, visit:
https://localhost:4610- Documentation site
Testing Example Changes
- Modify example files in
_examples/directories - The dev server will hot-reload changes
- Use the framework switcher to test across React/Angular/Vue
Debugging Build Issues
If the dev server shows errors:
- Check
ag-watch-status.jsonfor specific error messages - Run
yarn nx build <package>to see detailed build output - Fix TypeScript/lint errors before continuing
Performance Tips
- Keep the dev server running while developing
- Use
--skip-nx-cacheif you suspect caching issues - Run
yarn nx cleanif builds behave unexpectedly after branch switches
Converted and distributed by TomeVault | Claim this content