Skip to content

Latest commit

 

History

History
190 lines (121 loc) · 8.53 KB

README.md

File metadata and controls

190 lines (121 loc) · 8.53 KB
Raw
ignite-ui

Examples of Ignite UI for Angular Components

This repository contains an Angular browser app and 500+ examples on how to use Ignite UI for Angular components:

You can run each sample project individually from the ./samples folder or you can browse all samples in one website from the ./browser folder.

Branches

NOTE: You should use master branch of this repository if you want to run samples on your computer. Use the vnext branch only when you want to contribute new samples to this repository.

Preview

You can preview and browse all samples in this repository by opening our Angular Samples Browser. Alternatively, you you can view these samples with detailed information in our Angular Help Documentation.

In addition, you can run each sample project individually from the ./samples folder or you can run from the ./browser folder to browse all samples in one website (see instructions below).

Setup

To set up this project locally, clone this repository:

git clone https://github.com/IgniteUI/igniteui-angular-examples.git

Running Individual Sample

  • check out the master branch

  • in VS Code, open a folder with existing sample, e.g.

./samples/charts/category-chart/axis-options/

  • type npm install --legacy-peer-deps command in terminal window

  • type npm run start command in terminal window

  • Wait until the build is completed and then open http://localhost:4200 in your browser.

At this point, you should see a website hosted example of Ignite UI for Angular component

Running All Samples

  • check out the master branch

  • open VS Code as Administrator

  • open the folder that contains this repository, e.g.

C:\GitHub\igniteui-angular-examples\

  • select View - Terminal menu item

  • type npm install --legacy-peer-deps command in terminal window

This will install required packages and Ignite UI for Angular packages

  • type npm run start command in terminal window to start this application locally

Note this application copies all individually sample projects from ./samples to ./browser/src folder when it is about to start running. Therefore, any changes to ./browser/src will be overridden on consecutive run of the application.

Wait until the build is completed and then open http://localhost:4200 in your browser. You should see a website with navigation menu for browning all samples in this repository.

Learn More

To learn more about Ignite UI for Angular components, check out the Angular documentation.

Updating Version of IgniteUI Packages

Perform these steps to update version of Ignite UI for Angular packages in all samples. NOTE that the order of these steps is very important.

  • open this repo in VS Code
  • open browser.js file
  • navigate to the updateIG function
  • change version of Ignite UI for Angular packages in the packageUpgrades array
  • open terminal window
  • run cd browser command
  • run gulp updateIG command
  • run npm install --legacy-peer-deps command
  • create pull request with your changes
  • open the Igniteui-xplat-example repo in VS Code
  • update version of Ignite UI for Angular packages in Angular template
  • create pull request with your changes in Igniteui-xplat-example repo