From 7b9294a3603fa43d4da63b647bc0d34fb8dc52ff Mon Sep 17 00:00:00 2001 From: Victor Savkin Date: Tue, 18 Jan 2022 12:24:50 -0500 Subject: [PATCH] chore(repo): update readme --- README.md | 68 +++------------------ scripts/readme-fragments/getting-started.md | 15 ++++- scripts/readme-fragments/resources.md | 60 ++---------------- scripts/readme-fragments/what-is-nx.md | 33 +--------- 4 files changed, 30 insertions(+), 146 deletions(-) diff --git a/README.md b/README.md index cea6012029999..b67ec67a890bf 100644 --- a/README.md +++ b/README.md @@ -15,73 +15,25 @@ width="100%" alt="Nx - Smart, Fast and Extensible Build System">

-# What is Nx? +# Smart, Fast and Extensible Build System -🔎 **Smart, Fast and Extensible Build System** +Nx is a next generation build system with first class monorepo support and powerful integrations. -Nx is a smart, fast and extensible build system. It comes with first class monorepo support and powerful integrations. +A few links to help you get started: -### Best-in-Class Support for Monorepos - -Nx provides distributed graph-based task execution and computation caching. - -Nx is smart. It analyzes your workspace and figures out what can be affected by every code change. -That's why Nx doesn't rebuild and retest everything on every commit--it only rebuilds what is necessary -. - -Nx partitions commands into a graph of smaller tasks. Nx then runs those tasks in parallel, -and it can even distribute them across multiple machines without any configuration. - -Nx also uses a distributed computation cache. If someone has already built or tested similar code, Nx -will use their results to speed up the command for everyone else. - -### Holistic Dev Experience Powered by an Advanced CLI and Editor Plugins - -Nx helps scale your development from one team building one application to many teams building multiple -frontend and backend applications all in the same workspace. When using Nx, developers have a holistic dev -experience powered by an advanced CLI (with editor plugins), capabilities for controlled code sharing and -consistent code generation. - -### Rich Plugin Ecosystem - -Nx is an open platform with plugins for many modern tools and frameworks. It has support for -TypeScript, React, Angular, Cypress, Jest, Prettier, Nest.js, Next.js, Storybook, Ionic among others. With Nx, you get a -consistent dev experience regardless of the tools used. - -# Documentation & Resources - -Even though Nx isn't technology specific, we provide 3 separate flavours of the documentation site to it make it easier -for you to get up and running. For every link below, you will be able to select whether you want your examples to be -written in React, Node or Angular. - -- [Nx Documentation and Guides](https://nx.dev) -- [Intro into Nx](https://nx.dev/getting-started/intro) -- [Interactive Tutorial with Videos](https://nx.dev/tutorial/01-create-application) - -### Quick Start Videos - -- [Scale Your React Development with Nx](https://www.youtube.com/watch?v=sNz-4PUM0k8) -- [Scale your Node Development with Nx](https://www.youtube.com/watch?v=iIh5h_G52kI) -- [Modern Angular with Nx Dev Tools](https://www.youtube.com/watch?v=cXOkmOy-8dk) - -### Videos, Blogs, Books, Examples +- [Nx.Dev: Documentation, Guides, Interactive Tutorials](https://nx.dev) +- [Tutorial: Adding Nx to an Existing Monorepo](https://nx.dev/migration/adding-to-monorepo) +- [Official Nx YouTube Channel](https://www.youtube.com/c/Nrwl_io) +- [Blog Posts About Nx](https://blog.nrwl.io/nx/home)

Nx - Smart, Fast and Extensible Build System

-- [Official Nx YouTube Channel](https://www.youtube.com/c/Nrwl_io) -- [Scale React Development with Nx (Free Egghead course)](https://egghead.io/playlists/scale-react-development-with-nx-4038) -- [Official NxPlaybook video courses](https://nxplaybook.com) -- [Nx Dev Tools for Monorepos, In-Depth Explainer (React)](https://www.youtube.com/watch?v=jCf92IyR-GE) -- [Nx Dev Tools for Monorepos, In-Depth Explainer (Angular)](https://youtu.be/h5FIGDn5YM0) -- [Blog Posts About Nx](https://blog.nrwl.io/nx/home) -- [Angular Enterprise Monorepo Patterns Book (free)](https://go.nrwl.io/angular-enterprise-monorepo-patterns-new-book?utm_campaign=Book%3A%20Monorepo%20Patterns%2C%20Jan%202019&utm_source=Github&utm_medium=Banner%20Ad) -- [Nx Examples Repo](https://github.com/nrwl/nx-examples) - # Engage with the Core Team and the Community -- [The Nx Show Playlist on YouTube](https://www.youtube.com/playlist?list=PLakNactNC1dE8KLQ5zd3fQwu_yQHjTmR5). It's - a regular YouTube stream where we talk all things Nx. Join the stream, ask questions, etc. +- [Nx.Dev Community Page: Community Slack Channel, Newsletter, etc.](https://nx.dev/community) +- [The Nx Show Playlist on YouTube](https://www.youtube.com/playlist?list=PLakNactNC1dE8KLQ5zd3fQwu_yQHjTmR5). It's a + regular YouTube stream where we talk all things Nx. Join the stream, ask questions, etc. - [Follow Nx on Twitter](https://twitter.com/NxDevTools) ## Want to help? diff --git a/scripts/readme-fragments/getting-started.md b/scripts/readme-fragments/getting-started.md index b5a07943e05b4..8a3a31e4546bc 100644 --- a/scripts/readme-fragments/getting-started.md +++ b/scripts/readme-fragments/getting-started.md @@ -24,8 +24,9 @@ The `create-nx-workspace` command will ask you to select a preset, which will co ``` ? What to create in the new workspace (Use arrow keys) -❯ empty [an empty workspace with a layout that works best for building apps] - npm [an empty workspace set up to publish npm packages (similar to and compatible with yarn workspaces)] +❯ apps [an empty workspace with no plugins with a layout that works best for building apps] + core [an empty workspace with no plugins set up to publish npm packages (similar to yarn workspaces)] + ts [an empty workspace with the JS/TS plugin preinstalled] react [a workspace with a single React application] angular [a workspace with a single Angular application] next.js [a workspace with a single Next.js application] @@ -33,8 +34,16 @@ The `create-nx-workspace` command will ask you to select a preset, which will co nest [a workspace with a single Nest application] express [a workspace with a single Express application] web components [a workspace with a single app built using web components] + react-native [a workspace with a single React Native application] react-express [a workspace with a full stack application (React + Express)] - angular-nest [a workspace with a full stack application (Angular + Nest)] ``` Select the preset that works best for you. + +### Adding Nx to an Existing Monorepo + +Run: + +```bash +npx add-nx-to-monorepo@latest +``` diff --git a/scripts/readme-fragments/resources.md b/scripts/readme-fragments/resources.md index e210cab5ff895..30c8c3dbbe4b3 100644 --- a/scripts/readme-fragments/resources.md +++ b/scripts/readme-fragments/resources.md @@ -1,59 +1,11 @@ ## Documentation & Resources -Even though Nx isn't technology specific, we provide 3 separate flavours of the documentation site to it make it easier for you to get up and running. For every link below, you will be able to select whether you want your examples to be written in React, Node or Angular. - -- [Nx Documentation and Guides](https://nx.dev) -- [Intro into Nx](https://nx.dev/getting-started/intro) -- [Interactive Tutorial with Videos](https://nx.dev/tutorial/01-create-application) - -### Quick Start Videos - -- [Scale Your React Development with Nx](https://www.youtube.com/watch?v=sNz-4PUM0k8) -- [Scale your Node Development with Nx](https://www.youtube.com/watch?v=iIh5h_G52kI) -- [Modern Angular with Nx Dev Tools](https://www.youtube.com/watch?v=cXOkmOy-8dk) - -### Courses - - - - - - - - - - - - -
Scale React Development with NxNx WorkspacesAdvanced Nx Workspaces
- -

Nx - Scale React Development with Nx video course

- - 		- -

Nx Workspaces video course

- - 		- -

Nx Advanced Workspaces video course

- -
- -### Videos, Blogs, Books, Examples - -- [Nx Dev Tools for Monorepos, In-Depth Explainer (React)](https://www.youtube.com/watch?v=jCf92IyR-GE) - -- [Nx Dev Tools for Monorepos, In-Depth Explainer (Angular)](https://youtu.be/h5FIGDn5YM0) - -- [Youtube Channel with Nx-Related Videos](https://www.youtube.com/playlist?list=PLakNactNC1dHHWx4JIORwfnEajRv6FG5m) +A few links to help you get started: +- [Nx.Dev: Documentation, Guides, Interactive Tutorials](https://nx.dev) +- [Tutorial: Adding Nx to an Existing Monorepo](https://nx.dev/migration/adding-to-monorepo) +- [Official Nx YouTube Channel](https://www.youtube.com/c/Nrwl_io) - [Blog Posts About Nx](https://blog.nrwl.io/nx/home) -- [Angular Enterprise Monorepo Patterns Book (free)](https://go.nrwl.io/angular-enterprise-monorepo-patterns-new-book?utm_campaign=Book%3A%20Monorepo%20Patterns%2C%20Jan%202019&utm_source=Github&utm_medium=Banner%20Ad) - -- [Nx Examples Repo](https://github.com/nrwl/nx-examples) - -# Engage with the Core Team and the Community - -- [The Nx Show Playlist on YouTube](https://www.youtube.com/playlist?list=PLakNactNC1dE8KLQ5zd3fQwu_yQHjTmR5). It's a regular YouTube stream where we talk all things Nx. Join the stream, ask questions, etc. -- [Follow Nx on Twitter](https://twitter.com/NxDevTools) +

Nx - Smart, Fast and Extensible Build System

diff --git a/scripts/readme-fragments/what-is-nx.md b/scripts/readme-fragments/what-is-nx.md index b3bab4a3b415f..75602dd0fb7dc 100644 --- a/scripts/readme-fragments/what-is-nx.md +++ b/scripts/readme-fragments/what-is-nx.md @@ -1,32 +1,3 @@ -## What is Nx? +# Smart, Fast and Extensible Build System -🔎 **Smart, Fast and Extensible Build System** - -Nx is a smart, fast and extensible build system. It comes with first class monorepo support and powerful integrations. - -### Best-in-Class Support for Monorepos - -Nx provides distributed graph-based task execution and computation caching. - -Nx is smart. It analyzes your workspace and figures out what can be affected by every code change. -That's why Nx doesn't rebuild and retest everything on every commit--it only rebuilds what is necessary -. - -Nx partitions commands into a graph of smaller tasks. Nx then runs those tasks in parallel, -and it can even distribute them across multiple machines without any configuration. - -Nx also uses a distributed computation cache. If someone has already built or tested similar code, Nx -will use their results to speed up the command for everyone else. - -### Holistic Dev Experience Powered by an Advanced CLI and Editor Plugins - -Nx helps scale your development from one team building one application to many teams building multiple -frontend and backend applications all in the same workspace. When using Nx, developers have a holistic dev -experience powered by an advanced CLI (with editor plugins), capabilities for controlled code sharing and -consistent code generation. - -### Rich Plugin Ecosystem - -Nx is an open platform with plugins for many modern tools and frameworks. It has support for -TypeScript, React, Angular, Cypress, Jest, Prettier, Nest.js, Next.js, Storybook, Ionic among others. With Nx, you get a -consistent dev experience regardless of the tools used. +Nx is a next generation build system with first class monorepo support and powerful integrations.