TESTING.md

Testing XPlatform docs

This document explains process of testing cross-platform docs and their samples.

Building Docs

Use one of the following commands to build docs:

npm run buildAngular
npm run buildBlazor
npm run buildReact
npm run buildWebComponents

Hosting Docs

You can use one of the following commands to host docs locally:

npm run startAngular
npm run startBlazor
npm run startReact
npm run startWebComponents

Alternatively, you can open these docs on staging server:

• angular docs
• blazor docs
• react docs
• web-components react

Extracting Samples

You can get a list of links to samples used in cross-platform docs by first building all docs locally (see Building Docs section) and then running the following commands:

NOTE: these commands generate JSON files with links to samples on staging server

   gulp extractSampleLinks --server="staging" --plat=angular
   gulp extractSampleLinks --server="staging" --plat=blazor
   gulp extractSampleLinks --server="staging" --plat=react
   gulp extractSampleLinks --server="staging" --plat=wc

NOTE: these commands generate JSON files with links to samples on production server

   gulp extractSampleLinks --server="production" --plat=angular
   gulp extractSampleLinks --server="production" --plat=blazor
   gulp extractSampleLinks --server="production" --plat=react
   gulp extractSampleLinks --server="production" --plat=wc

NOTE: these commands generates JSON files with links to samples on local server

   gulp extractSampleLinks --server="local" --plat=angular
   gulp extractSampleLinks --server="local" --plat=blazor
   gulp extractSampleLinks --server="local" --plat=react
   gulp extractSampleLinks --server="local" --plat=wc

Open generated JSON files in VS Code and then hold CTRL key and click a link to open it browser.

NOTE: links to local samples will work when you run samples browser locally from these repos:

• igniteui-angular-examples
• igniteui-blazor-examples
• igniteui-react-examples
• igniteui-wc-examples