UNPKG

3.55 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
22This package is a [Jest plugin for Nx](https://nx.dev/jest/overview).
23
24## Getting Started
25
26### Creating an Nx Workspace
27
28**Using `npx`**
29
30```bash
31npx create-nx-workspace
32```
33
34**Using `npm init`**
35
36```bash
37npm init nx-workspace
38```
39
40**Using `yarn create`**
41
42```bash
43yarn create nx-workspace
44```
45
46The `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.
47
48```
49? What to create in the new workspace (Use arrow keys)
50❯ apps [an empty workspace with no plugins with a layout that works best for building apps]
51 core [an empty workspace with no plugins set up to publish npm packages (similar to yarn workspaces)]
52 ts [an empty workspace with the JS/TS plugin preinstalled]
53 react [a workspace with a single React application]
54 angular [a workspace with a single Angular application]
55 next.js [a workspace with a single Next.js application]
56 nest [a workspace with a single Nest application]
57 express [a workspace with a single Express application]
58 web components [a workspace with a single app built using web components]
59 react-native [a workspace with a single React Native application]
60 react-express [a workspace with a full stack application (React + Express)]
61```
62
63Select the preset that works best for you
64
65### Adding Nx to an Existing Monorepo
66
67Run:
68
69```bash
70npx add-nx-to-monorepo@latest
71```
72
73## Documentation & Resources
74
75A few links to help you get started:
76
77- [Nx.Dev: Documentation, Guides, Interactive Tutorials](https://nx.dev)
78- [Tutorial: Adding Nx to an Existing Monorepo](https://nx.dev/migration/adding-to-monorepo)
79- [Official Nx YouTube Channel](https://www.youtube.com/c/Nrwl_io)
80- [Blog Posts About Nx](https://blog.nrwl.io/nx/home)
81
82<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"
83width="100%" alt="Nx - Smart, Fast and Extensible Build System"></a></p>
84