diff --git a/packages/workspace/src/schematics/workspace/files/README.md b/packages/workspace/src/schematics/workspace/files/README.md index 0f2a7ae4d1cc3..1a6b207460374 100644 --- a/packages/workspace/src/schematics/workspace/files/README.md +++ b/packages/workspace/src/schematics/workspace/files/README.md @@ -8,34 +8,77 @@ This project was generated using [Nx](https://nx.dev). ## Quick Start & Documentation +[Nx Documentation](https://nx.dev) + [30-minute video showing all Nx features](https://nx.dev/getting-started/what-is-nx) -[Interactive tutorial](https://nx.dev/tutorial/01-create-application) +[Interactive Tutorial](https://nx.dev/tutorial/01-create-application) + +## Adding capabilities to your workspace + +Nx supports many plugins which add capabilities for developing different types of applications and different tools. + +These capabilities include generating applications, libraries, .etc as well as the devtools to test, and build projects as well. + +Below are some plugins which you can add to your workspace: + +- [Angular](https://angular.io) + - `ng add @nrwl/angular` +- [React](https://reactjs.org) + - `ng add @nrwl/react` +- Web (no framework frontends) + - `ng add @nrwl/web` +- [Nest](https://nestjs.com) + - `ng add @nrwl/nest` +- [Express](https://expressjs.com) + - `ng add @nrwl/express` +- [Node](https://nodejs.org) + - `ng add @nrwl/node` + +## Generate an application + +Run `ng g @nrwl/angular:app my-app` to generate an application. -## Generate your first application +> You can use any of the plugins above to generate applications as well. -Run `ng g app myapp` to generate an application. When using Nx, you can create multiple applications and libraries in the same CLI workspace. +When using Nx, you can create multiple applications and libraries in the same workspace. + +## Generate a library + +Run `ng g @nrwl/angular:lib my-lib` to generate a library. + +> You can also use any of the plugins above to generate libraries as well. + +Libraries are sharable across libraries and applications. They can be imported from `@<%= name %>/mylib`. ## Development server -Run `ng serve myapp` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files. +Run `ng serve my-app` for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files. ## Code scaffolding -Run `ng generate component component-name --project=myapp` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`. +Run `ng g component my-component --project=my-app` to generate a new component. ## Build -Run `ng build myapp` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build. +Run `ng build my-app` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build. ## Running unit tests -Run `ng test` to execute the unit tests via [Jest](https://jestjs.io). +Run `ng test my-app` to execute the unit tests via [Jest](https://jestjs.io). + +Run `npm run affected:test` to execute the unit tests affected by a change. ## Running end-to-end tests -Run `ng e2e` to execute the end-to-end tests via [Cypress](https://www.cypress.io). +Run `ng e2e my-app` to execute the end-to-end tests via [Cypress](https://www.cypress.io). + +Run `npm run affected:e2e` to execute the end-to-end tests affected by a change. + +## Understand your workspace + +Run `npm run dep-graph` to see a diagram of the dependencies of your projects. ## Further help -To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md). +Visit the [Nx Documentation](https://nx.dev) to learn more.