206 lines
8.9 KiB
Markdown
206 lines
8.9 KiB
Markdown
<p align="center"><img src="https://raw.githubusercontent.com/nrwl/nx/master/nx-logo.png" width="450"></p>
|
||
|
||
<div align="center">
|
||
|
||
[](https://circleci.com/gh/nrwl/nx)
|
||
[]()
|
||
[](https://www.npmjs.com/@nrwl/workspace)
|
||
[]()
|
||
[](http://commitizen.github.io/cz-cli/)
|
||
[](https://gitter.im/nrwl-nx/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||
[](https://join.slack.com/t/nrwlcommunity/shared_invite/enQtNzU5MTE4OTQwOTk0LTgxY2E0ZWYzMWE0YzA5ZDA2MWM1NDVhNmI2ZWMyYmZhNWJiODk3MjkxZjY3MzU5ZjRmM2NmNWU1OTgyZmE4Mzc)
|
||
|
||
</div>
|
||
|
||
<hr>
|
||
|
||
# What is Nx?
|
||
|
||
🔎 **Extensible Dev Tools for Monorepos.**
|
||
|
||
## Nx Helps You
|
||
|
||
### Use Modern Tools
|
||
|
||
Using Nx, you can add TypeScript, Cypress, Jest, Prettier, Angular, React, Storybook, Next.js and Nest into your dev workflow. Nx sets up these tools and allows you to use them seamlessly. Nx fully integrates with the other modern tools you already use and love.
|
||
|
||
### Build Full-Stack Applications
|
||
|
||
With Nx, you can build full-stack applications using modern frameworks. You can share code between the frontend and the backend. And you can use the same `build/test/serve` commands throughout the whole dev experience.
|
||
|
||
### Develop like Google, Facebook, and Microsoft
|
||
|
||
With Nx, you can develop multiple full-stack applications holistically and share code between them all in the same workspace. Nx provides advanced tools which help you scale your enterprise development. Nx also helps enforce your organization’s standards and community best practices.
|
||
|
||
# Getting Started
|
||
|
||
## Creating an Nx Workspace
|
||
|
||
**Using `npx`**
|
||
|
||
```bash
|
||
npx create-nx-workspace
|
||
```
|
||
|
||
**Using `npm init`**
|
||
|
||
```bash
|
||
npm init nx-workspace
|
||
```
|
||
|
||
**Using `yarn create`**
|
||
|
||
```bash
|
||
yarn create nx-workspace
|
||
```
|
||
|
||
If it's your first Nx project, the command will recommend you to install `@nrwl/cli` globally, so you can invoke `nx` directly without going through yarn or npm.
|
||
|
||
## Creating First Application
|
||
|
||
By default, an Nx workspace starts blank. There are no applications to build, serve, and test. To create one, you need to add capabilities to the workspace.
|
||
|
||
**To add a web components app, run:**
|
||
|
||
```bash
|
||
yarn add --dev @nrwl/web
|
||
nx g @nrwl/web:app myapp # or just "nx g myapp"
|
||
```
|
||
|
||
```bash
|
||
npm install --save-dev @nrwl/web
|
||
nx g @nrwl/web:app myapp # or just "nx g myapp"
|
||
```
|
||
|
||
**To add an Angular app, run:**
|
||
|
||
```bash
|
||
yarn add --dev @nrwl/angular
|
||
nx g @nrwl/angular:app myapp # or just "nx g myapp"
|
||
```
|
||
|
||
```bash
|
||
npm install --save-dev @nrwl/angular
|
||
nx g @nrwl/angular:app myapp # or just "nx g myapp"
|
||
```
|
||
|
||
**To add a React app, run:**
|
||
|
||
```bash
|
||
yarn add --dev @nrwl/react
|
||
nx g @nrwl/react:app myapp # or just "nx g myapp"
|
||
```
|
||
|
||
```bash
|
||
npm install --save-dev @nrwl/react
|
||
nx g @nrwl/react:app myapp # or just "nx g myapp"
|
||
```
|
||
|
||
If `nx g` fails, use: `yarn nx g @nrwl/web:app myapp` or `npm run nx -- g @nrwl/web:app myapp`.
|
||
|
||
Regardless of what framework you chose, the resulting file tree will look like this:
|
||
|
||
```treeview
|
||
<workspace name>/
|
||
├── apps/
|
||
│ ├── myapp/
|
||
│ └── myapp-e2e/
|
||
├── libs/
|
||
├── tools/
|
||
├── nx.json
|
||
├── package.json
|
||
├── tsconfig.json
|
||
└── tslint.json
|
||
```
|
||
|
||
## 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.
|
||
|
||
Angular users can also run `ng g/serve/test/e2e`.
|
||
|
||
You are good to go!
|
||
|
||
### Documentation
|
||
|
||
- [Nx Documentation and Guides](https://nx.dev)
|
||
- [Nx blog posts](https://blog.nrwl.io/nx/home)
|
||
|
||
### Quick Start Videos
|
||
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<a href="https://www.youtube.com/watch?v=mVKMse-gFBI" target="_blank">
|
||
<p align="center">Angular<br><img src="https://raw.githubusercontent.com/nrwl/nx/master/nx-angular-video.png" width="350"></p>
|
||
</a>
|
||
</td>
|
||
<td>
|
||
<a href="https://www.youtube.com/watch?v=E188J7E_MDU" target="_blank">
|
||
<p align="center">React<br><img src="https://raw.githubusercontent.com/nrwl/nx/master/nx-react-video.png" width="350"></p>
|
||
</a>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
|
||
### Courses
|
||
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<a href="https://www.youtube.com/watch?v=2mYLe9Kp9VM&list=PLakNactNC1dH38AfqmwabvOszDmKriGco" target="_blank">
|
||
<p align="center"><img src="https://raw.githubusercontent.com/nrwl/nx/master/nx-workspace-course.png" width="350"></p>
|
||
</a>
|
||
</td>
|
||
<td>
|
||
<a href="https://nxplaybook.com/p/advanced-nx-workspaces" target="_blank">
|
||
<p align="center"><img src="https://raw.githubusercontent.com/nrwl/nx/master/advanced-nx-workspace-course.png" width="350"></p>
|
||
</a>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
|
||
### Books
|
||
|
||
- [Effective React Development with Nx](https://go.nrwl.io/effective-react-development-with-nx-new-book)
|
||
- [Angular Enterprise Monorepo Patterns](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)
|
||
|
||
### Videos
|
||
|
||
- [Building Angular full-stack applications in a monorepo.](https://www.youtube.com/watch?v=XZpp52IqD2A&t=1292s)
|
||
- [Building React full-stack applications in a monorepo.](https://www.youtube.com/watch?v=Jxh_--FeJeY&t=2s)
|
||
|
||
### Talks
|
||
|
||
- [Angular at Large Organizations](https://www.youtube.com/watch?v=piQ0EZhtus0)
|
||
- [Nx: The New Way to Build Enterprise Angular Apps](https://www.youtube.com/watch?v=xo-1SDmvM8Y)
|
||
- [Supercharging the Angular CLI](https://www.youtube.com/watch?v=bMkKz8AedHc)
|
||
- [Hands on Full Stack development with Nx and Bazel](https://www.youtube.com/watch?v=1KDDIhcQORM)
|
||
|
||
## Misc
|
||
|
||
- [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.
|
||
- [xplat - Cross-platform tools for Nx workspaces](https://nstudio.io/xplat/)
|
||
|
||
## Want to help?
|
||
|
||
If you want to file a bug or submit a PR, read up on our [guidelines for contributing](https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md) and watch this video that will help you get started.
|
||
|
||
<a href="https://www.youtube.com/watch?v=o11p0zSm0No&feature=youtu.be" target="_blank">
|
||
<p align="center"><img src="https://raw.githubusercontent.com/nrwl/nx/master/how-to-contribute.png" width="600"></p>
|
||
</a>
|
||
|
||
## Core Team
|
||
|
||
| Victor Savkin | Jason Jean | Benjamin Cabanes | Brandon Roberts |
|
||
| ---------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
|
||
|  |  |  |  |
|
||
| [vsavkin](https://github.com/vsavkin) | [FrozenPandaz](https://github.com/FrozenPandaz) | [bcabanes](https://github.com/bcabanes) | [brandonroberts](https://github.com/brandonroberts) |
|
||
|
||
| Jack Hsu | Jo Hanna Pearce | Matt Briggs |
|
||
| --------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
|
||
|  |  |  |
|
||
| [jaysoo](https://github.com/jaysoo) | [jdpearce](https://github.com/jdpearce) | [mbriggs](https://github.com/mbriggs) |
|