From e3c7335c5e78892e1e836e160b7882b5bf4fd696 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miroslav=20Jona=C5=A1?= Date: Wed, 5 May 2021 12:57:07 +0200 Subject: [PATCH] docs(README): update the outdated documentation (#146) * docs(README): update the outdated documentation * chore(format): fix formatting * docs(README): add additional links to cloud section --- README.md | 62 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 38 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 2d6c753..f1f6f4a 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,7 @@ This project was generated using [Nx](https://nx.dev).

-🔎 **Nx is a set of Angular CLI power-ups for modern development.** - -## Nx 5 Example - -If you are looking for the Nx 5 Example, it is available on the [`nx-v5-example` branch](https://github.com/nrwl/nx-examples/commits/nx-v5-example). +🔎 **Powerful, Extensible Dev Tools** ## Quick Start & Documentation @@ -22,26 +18,28 @@ If you are looking for the Nx 5 Example, it is available on the [`nx-v5-example` 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. +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: +Below are our core plugins: -- [Angular](https://angular.io) - - `ng add @nrwl/angular` - [React](https://reactjs.org) - - `ng add @nrwl/react` + - `npm install --save-dev @nrwl/react` - Web (no framework frontends) - - `ng add @nrwl/web` + - `npm install --save-dev @nrwl/web` +- [Angular](https://angular.io) + - `npm install --save-dev @nrwl/angular` - [Nest](https://nestjs.com) - - `ng add @nrwl/nest` + - `npm install --save-dev @nrwl/nest` - [Express](https://expressjs.com) - - `ng add @nrwl/express` + - `npm install --save-dev @nrwl/express` - [Node](https://nodejs.org) - - `ng add @nrwl/node` + - `npm install --save-dev @nrwl/node` + +There are also many [community plugins](https://nx.dev/nx-community) you could add. ## Generate an application -Run `ng g @nrwl/angular:app my-app` to generate an application. +Run `nx g @nrwl/react:app my-app` to generate an application. > You can use any of the plugins above to generate applications as well. @@ -49,40 +47,56 @@ When using Nx, you can create multiple applications and libraries in the same wo ## Generate a library -Run `ng g @nrwl/angular:lib my-lib` to generate a library. +Run `nx g @nrwl/react: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 `@nx-example/mylib`. +Libraries are shareable across libraries and applications. They can be imported from `@nx-example/mylib`. ## Development server -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. +Run `nx 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 g component my-component --project=my-app` to generate a new component. +Run `nx g @nrwl/react:component my-component --project=my-app` to generate a new component. ## 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. +Run `nx 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 my-app` to execute the unit tests via [Jest](https://jestjs.io). +Run `nx 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. +Run `nx affected:test` to execute the unit tests affected by a change. ## Running end-to-end tests 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. +Run `nx 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. +Run `nx dep-graph` to see a diagram of the dependencies of your projects. ## Further help Visit the [Nx Documentation](https://nx.dev) to learn more. + +## ☁ Nx Cloud + +### Computation Caching in the Cloud + +

+ +Nx Cloud pairs with Nx in order to enable you to build and test code more rapidly, by up to 10 times. Even teams that are new to Nx can connect to Nx Cloud and start saving time instantly. + +Teams using Nx gain the advantage of building full-stack applications with their preferred framework alongside Nx’s advanced code generation and project dependency graph, plus a unified experience for both frontend and backend developers. + +[Nx Cloud](https://nx.app/) + +[Computation Caching Fundamentals](https://blog.nrwl.io/computation-caching-the-fundamentals-behind-nxs-lightning-fast-execution-dc761fe41eb8) + +[Computation Caching with NX](https://nx.dev/latest/core-concepts/computation-caching)