angular/packages/examples/README.md

# API Examples

This folder contains small example apps that get in-lined into our API docs.
Each example contains tests for application behavior (as opposed to testing Angular's
behavior) just like an Angular application developer would write.

# Running the examples

```
# Serving individual examples (e.g. common)
pnpm bazel run //packages/examples/common:devserver

# "core" examples
pnpm bazel run //packages/examples/core:devserver
```

# Running the tests

```
pnpm bazel test //packages/examples/...
```
chore(examples): explain the purpose of these examples 2015-10-30 18:31:26 +00:00			`# API Examples`

			`This folder contains small example apps that get in-lined into our API docs.`
			`Each example contains tests for application behavior (as opposed to testing Angular's`
			`behavior) just like an Angular application developer would write.`
fix: Better instructions on running examples and their tests 2016-12-08 05:41:21 +00:00
			`# Running the examples`

			```
build: switch example e2e tests to bazel (#28402) * No longer builds the example e2e tests using "tsc". The examples are now built with Bazel and can therefore be built with Ivy by using the `--define=compile=aot` switch. * No longer runs the example e2e tests using the protractor CLI. example e2e tests are executed with the Bazel protractor rule and can therefore run incrementally. NOTE: Unit tests found within the examples are still running within the legacy jobs. PR Close #28402 2019-01-28 20:59:25 +00:00			`# Serving individual examples (e.g. common)`
build: use pnpm as the package manager instead of yarn (#62924) Use pnpm instead of yarn as the package manager and interaction tool for the repo PR Close #62924 2025-07-31 15:17:27 +00:00			`pnpm bazel run //packages/examples/common:devserver`
fix: Better instructions on running examples and their tests 2016-12-08 05:41:21 +00:00
build: switch example e2e tests to bazel (#28402) * No longer builds the example e2e tests using "tsc". The examples are now built with Bazel and can therefore be built with Ivy by using the `--define=compile=aot` switch. * No longer runs the example e2e tests using the protractor CLI. example e2e tests are executed with the Bazel protractor rule and can therefore run incrementally. NOTE: Unit tests found within the examples are still running within the legacy jobs. PR Close #28402 2019-01-28 20:59:25 +00:00			`# "core" examples`
build: use pnpm as the package manager instead of yarn (#62924) Use pnpm instead of yarn as the package manager and interaction tool for the repo PR Close #62924 2025-07-31 15:17:27 +00:00			`pnpm bazel run //packages/examples/core:devserver`
fix: Better instructions on running examples and their tests 2016-12-08 05:41:21 +00:00			```

			`# Running the tests`

			```
build: use pnpm as the package manager instead of yarn (#62924) Use pnpm instead of yarn as the package manager and interaction tool for the repo PR Close #62924 2025-07-31 15:17:27 +00:00			`pnpm bazel test //packages/examples/...`
build: format md files This commit configures prettier to format markdown files. 2025-11-06 18:03:05 +00:00			```