UNPKG

@nrwl/workspace/README.md

Version:

2.25 kBMarkdownView Raw

1<p style="text-align: center;"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx.png" width="600" alt="Nx - Smart, Fast and Extensible Build System"></p>
2
3<div style="text-align: center;">
4
5[![CircleCI](https://circleci.com/gh/nrwl/nx.svg?style=svg)](https://circleci.com/gh/nrwl/nx)
6[![License](https://img.shields.io/npm/l/@nrwl/workspace.svg?style=flat-square)]()
7[![NPM Version](https://badge.fury.io/js/%40nrwl%2Fworkspace.svg)](https://www.npmjs.com/@nrwl/workspace)
8[![Semantic Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)]()
9[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
10[![Join the chat at https://gitter.im/nrwl-nx/community](https://badges.gitter.im/nrwl-nx/community.svg)](https://gitter.im/nrwl-nx/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
11[![Join us @nrwl/community on slack](https://img.shields.io/badge/slack-%40nrwl%2Fcommunity-brightgreen)](https://join.slack.com/t/nrwlcommunity/shared_invite/enQtNzU5MTE4OTQwOTk0LTgxY2E0ZWYzMWE0YzA5ZDA2MWM1NDVhNmI2ZWMyYmZhNWJiODk3MjkxZjY3MzU5ZjRmM2NmNWU1OTgyZmE4Mzc)
12
13</div>
14
15
16<hr>
17
18# Nx: Smart, Fast and Extensible Build System
19
20Nx is a next generation build system with first class monorepo support and powerful integrations.
21
22## Getting Started
23
24### Creating an Nx Workspace
25
26**Using `npx`**
27
28```bash
29npx create-nx-workspace
30```
31
32**Using `npm init`**
33
34```bash
35npm init nx-workspace
36```
37
38**Using `yarn create`**
39
40```bash
41yarn create nx-workspace
42```
43
44### Adding Nx to an Existing Repository
45
46Run:
47
48```bash
49npx nx@latest init
50```
51
52## Documentation & Resources
53
54- [Nx.Dev: Documentation, Guides, Tutorials](https://nx.dev)
55- [Intro to Nx](https://nx.dev/getting-started/intro)
56- [Official Nx YouTube Channel](https://www.youtube.com/@NxDevtools)
57- [Blog Posts About Nx](https://blog.nrwl.io/nx/home)
58
59<p style="text-align: center;"><a href="https://nx.dev/#learning-materials" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-courses-and-videos.svg" 
60width="100%" alt="Nx - Smart, Fast and Extensible Build System"></a></p>
61

1	`<p style="text-align: center;"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx.png" width="600" alt="Nx - Smart, Fast and Extensible Build System"></p>`
2
3	`<div style="text-align: center;">`
4
5	`[![CircleCI](https://circleci.com/gh/nrwl/nx.svg?style=svg)](https://circleci.com/gh/nrwl/nx)`
6	`[![License](https://img.shields.io/npm/l/@nrwl/workspace.svg?style=flat-square)]()`
7	`[![NPM Version](https://badge.fury.io/js/%40nrwl%2Fworkspace.svg)](https://www.npmjs.com/@nrwl/workspace)`
8	`[![Semantic Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)]()`
9	`[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)`
10	`[![Join the chat at https://gitter.im/nrwl-nx/community](https://badges.gitter.im/nrwl-nx/community.svg)](https://gitter.im/nrwl-nx/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)`
11	`[![Join us @nrwl/community on slack](https://img.shields.io/badge/slack-%40nrwl%2Fcommunity-brightgreen)](https://join.slack.com/t/nrwlcommunity/shared_invite/enQtNzU5MTE4OTQwOTk0LTgxY2E0ZWYzMWE0YzA5ZDA2MWM1NDVhNmI2ZWMyYmZhNWJiODk3MjkxZjY3MzU5ZjRmM2NmNWU1OTgyZmE4Mzc)`
12
13	`</div>`
14
15
16	`<hr>`
17
18	`# Nx: Smart, Fast and Extensible Build System`
19
20	`Nx is a next generation build system with first class monorepo support and powerful integrations.`
21
22	`## Getting Started`
23
24	`### Creating an Nx Workspace`
25
26	Using `npx`
27
28	```bash
29	`npx create-nx-workspace`
30	```
31
32	Using `npm init`
33
34	```bash
35	`npm init nx-workspace`
36	```
37
38	Using `yarn create`
39
40	```bash
41	`yarn create nx-workspace`
42	```
43
44	`### Adding Nx to an Existing Repository`
45
46	`Run:`
47
48	```bash
49	`npx nx@latest init`
50	```
51
52	`## Documentation & Resources`
53
54	`- [Nx.Dev: Documentation, Guides, Tutorials](https://nx.dev)`
55	`- [Intro to Nx](https://nx.dev/getting-started/intro)`
56	`- [Official Nx YouTube Channel](https://www.youtube.com/@NxDevtools)`
57	`- [Blog Posts About Nx](https://blog.nrwl.io/nx/home)`
58
59	`<p style="text-align: center;"><a href="https://nx.dev/#learning-materials" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-courses-and-videos.svg"`
60	`width="100%" alt="Nx - Smart, Fast and Extensible Build System"></a></p>`
61