From afc6fafe2444eec61c737540a688e5300890865e Mon Sep 17 00:00:00 2001 From: vsavkin Date: Tue, 18 May 2021 14:21:59 -0400 Subject: [PATCH] chore(repo): clean up readme --- CODE_OF_CONDUCT.md | 11 ++ README.md | 138 ++++--------------------- scripts/readme-fragments/what-is-nx.md | 14 +-- 3 files changed, 40 insertions(+), 123 deletions(-) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000000..a0fa3de6f9224 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,11 @@ +# Contributor Code of Conduct + +As contributors and maintainers of the Nx project, we pledge to respect everyone who contributes by posting issues, updating documentation, submitting pull requests, providing feedback in comments, and any other activities. + +Communication through any of Nx's channels (GitHub, Gitter, Slack, IRC, mailing lists, Twitter, etc.) must be constructive and never resort to personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct. + +We promise to extend courtesy and respect to everyone involved in this project regardless of gender, gender identity, sexual orientation, disability, age, race, ethnicity, religion, or level of experience. We expect anyone contributing to the Nx project to do the same. + +If any member of the community violates this code of conduct, the maintainers of the Nx project may take action, removing issues, comments, and PRs or blocking accounts as deemed appropriate. + +If you are subject to or witness unacceptable behavior, or have any other concerns, please email us at conduct@nrwl.io. diff --git a/README.md b/README.md index 3c14bf52ccfe3..58290d95c4100 100644 --- a/README.md +++ b/README.md @@ -16,103 +16,37 @@ # What is Nx? -🔎 **Powerful, Extensible Dev Tools.** +🔎 **Powerful, Extensible Dev Tools** -## Nx Helps You - -### Develop like Google, Facebook, and Microsoft - -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. - -### Use Intelligent Build System with Distributed Caching +### Use Intelligent Build System with Distributed Caching & Distributed Task Execution 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 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 instead of rebuilding or retesting the code from scratch. This, in combination with Nx’s support for distributed and incremental builds, can help teams see up to 10x reduction in build and test times. - -### Use Modern Tools - -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. - -# Getting Started - -## Creating an Nx Workspace - -**Using `npx`** - -```bash -npx create-nx-workspace -``` +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 instead of rebuilding or retesting the code from scratch. -**Using `npm init`** +This, in combination with Nx’s support for config-free distributed task execution, where a command can be split and ran on many machines in parallel, can help teams see up to 10x reduction in build and test times. -```bash -npm init nx-workspace -``` +### Develop Efficiently at Scale with Nx -**Using `yarn create`** - -```bash -yarn create nx-workspace -``` - -The `create-nx-workspace` command will ask you to select a preset, which will configure some plugins and create your applications to help you get started. - -``` -? What to create in the new workspace (Use arrow keys) -❯ empty [an empty workspace with a layout that works best for building apps] - oss [an empty workspace with a layout that works best for open-source projects] - web components [a workspace with a single app built using web components] - angular [a workspace with a single Angular application] - angular-nest [a workspace with a full stack application (Angular + Nest)] - react [a workspace with a single React application] - react-express [a workspace with a full stack application (React + Express)] - next.js [a workspace with a single Next.js application] -``` - -Select the preset that works best for you. You can always add plugins later. - -``` -? Workspace name (e.g., org name) happyorg -? What to create in the new workspace web components [a workspace with a single app built using web components] -? Application name myapp -? Default stylesheet format CSS -``` - -If it's your first Nx project, the command will recommend you to install the `nx` package globally, so you can invoke `nx` directly without going through yarn or npm. - -## Serving Application - -- Run `nx serve myapp` to serve the newly generated application! -- Run `nx test myapp` to test it. -- Run `nx e2e myapp-e2e` to run e2e tests for it. +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. -Angular users can also run `ng g/serve/test/e2e`. +### Use Modern Tools -You are good to go! +Nx is an open framework 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. -## Resources +# Documentation & Resources -### Documentation +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 - - - - - -
- -

Angular
Nx - Quick Start Video for Angular

- - 		- -

React
Nx - Quick Start Video for React

- -
+- [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 @@ -141,52 +75,24 @@ You are good to go! -### Nx Demo & Tutorial Videos +### 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) -- [Storybook Integration with Nx](https://youtu.be/sFpqyjT7u4s) - -- [Building Custom Plugins for Nx](https://youtu.be/XYO689PAhow) - -- [Improved Dependency Graph Visualization for Nx](https://youtu.be/cMZ-ReC-jWU) - -- [Group all your stories into a single viewable Storybook with Nx](https://youtu.be/c323HOuFKkA) - -- [Debug Nx with Node and VSCode](https://youtu.be/OGV4R0cPRPc) +- [Youtube Channel with Nx-Related Videos](https://www.youtube.com/playlist?list=PLakNactNC1dHHWx4JIORwfnEajRv6FG5m) -- [Debug your Jest tests in Nx with VSCode](https://youtu.be/9_lgM2nokLg) - -- [Nx Console - A Must-Have Visual Studio Code Extension for Angular Developers](https://youtu.be/IIetmfgozgI) - -- [Introducing Nx Cloud](https://youtu.be/pwG20nNTEQc) - -- [Setting up distributed caching using Nx Cloud, @nrwl/nx-cloud](https://youtu.be/w1-GiB74ddc) - -- [High Quality React apps with Nx & Cypress](https://youtu.be/mfJBLhjYMdo) - -### Books and Blogs - -- [Nx blog posts](https://blog.nrwl.io/nx/home) +- [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) -- [High Quality React apps with Nx & Cypress](https://cypress.io/blog/2020/04/14/high-quality-react-apps-with-nx-cypress/) (April 2020) - -- [Shell Library patterns with Nx and Monorepo Architectures](https://indepth.dev/the-shell-library-patterns-with-nx-and-monorepo-architectures/) (March 2020) - -- [Tiny Angular application projects in Nx workspaces](https://indepth.dev/tiny-angular-application-projects-in-nx-workspaces/#peer-reviewers--30/) (March 2020) - -### Additional Resources - -- [nx-examples](https://github.com/nrwl/nx-examples) repo has branches for different nx comments to display expected behavior and example app and libraries. Check out the branch (workspace, ngrx...) to see what gets created for you. More info on readme. +- [Nx Examples Repo](https://github.com/nrwl/nx-examples) -- [xplat - Cross-platform tools for Nx workspaces](https://nstudio.io/xplat/) -- [Nrwl Talks, Presentations, and Podcasts playlist on YouTube](https://www.youtube.com/playlist?list=PLakNactNC1dHHWx4JIORwfnEajRv6FG5m) +# Engage with the Core Team and the Community -- [Nx Office Hours playlist on YouTube](https://www.youtube.com/playlist?list=PLakNactNC1dE8KLQ5zd3fQwu_yQHjTmR5) +- [Nx Office Hours 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/what-is-nx.md b/scripts/readme-fragments/what-is-nx.md index b9839e7a43a17..9d7d589136e9d 100644 --- a/scripts/readme-fragments/what-is-nx.md +++ b/scripts/readme-fragments/what-is-nx.md @@ -2,18 +2,18 @@ 🔎 **Powerful, Extensible Dev Tools** -## Nx Helps You +### Use Intelligent Build System with Distributed Caching & Distributed Task Execution -### Develop like Google, Facebook, and Microsoft +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 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. +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 instead of rebuilding or retesting the code from scratch. -### Use Intelligent Build System with Distributed Caching +This, in combination with Nx’s support for config-free distributed task execution, where a command can be split and ran on many machines in parallel, can help teams see up to 10x reduction in build and test times. -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. +### Develop Efficiently at Scale with Nx -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 instead of rebuilding or retesting the code from scratch. This, in combination with Nx’s support for distributed and incremental builds, can help teams see up to 10x reduction in build and test times. +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. ### Use Modern Tools -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 an open framework 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.