UNPKG

@nrwl/workspace

Version:

The Workspace plugin contains executors and generators that are useful for any Nx workspace. It should be present in every Nx workspace and other plugins build on it.

83 lines (56 loc) 3.46 kB
<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> <div style="text-align: center;"> [![CircleCI](https://circleci.com/gh/nrwl/nx.svg?style=svg)](https://circleci.com/gh/nrwl/nx) [![License](https://img.shields.io/npm/l/@nrwl/workspace.svg?style=flat-square)]() [![NPM Version](https://badge.fury.io/js/%40nrwl%2Fworkspace.svg)](https://www.npmjs.com/@nrwl/workspace) [![Semantic Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)]() [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![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) [![Join us @nrwl/community on slack](https://img.shields.io/badge/slack-%40nrwl%2Fcommunity-brightgreen)](https://join.slack.com/t/nrwlcommunity/shared_invite/enQtNzU5MTE4OTQwOTk0LTgxY2E0ZWYzMWE0YzA5ZDA2MWM1NDVhNmI2ZWMyYmZhNWJiODk3MjkxZjY3MzU5ZjRmM2NmNWU1OTgyZmE4Mzc) </div> <hr> # Nx: Smart, Fast and Extensible Build System Nx is a next generation build system with first class monorepo support and powerful integrations. ## 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 ``` 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) ❯ 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] 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)] ``` Select the preset that works best for you ### Adding Nx to an Existing Monorepo Run: ```bash npx add-nx-to-monorepo@latest ``` ## Documentation & Resources A few links to help you get started: - [Nx.Dev: Documentation, Guides, Interactive Tutorials](https://nx.dev) - [Tutorial: Adding Nx to an Existing Monorepo](/recipe/adding-to-monorepo) - [Official Nx YouTube Channel](https://www.youtube.com/c/Nrwl_io) - [Blog Posts About Nx](https://blog.nrwl.io/nx/home) <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" width="100%" alt="Nx - Smart, Fast and Extensible Build System"></a></p>