766d1b32e0
This PR removes installation instructions for Nx < 18 since it has fallen out of support window. Users can always `npm install <plugin>` as usual if they are on an unsupported Nx version, but the docs will assume `nx add` moving forward. The changes are on the plugin overview page: https://nx-dev-git-docs-remove-nx-pre-18-install-nrwl.vercel.app/nx-api
38 lines
1.3 KiB
Markdown
38 lines
1.3 KiB
Markdown
---
|
|
title: Express Plugin for Nx
|
|
description: Learn how to use the @nx/express plugin to create and manage Express applications in your Nx workspace, including setup and common recipes.
|
|
---
|
|
|
|
[Express](https://expressjs.com/) is a mature, minimal, and an open source web framework for making web applications and
|
|
apis.
|
|
|
|
## Create a New Workspace
|
|
|
|
To create a new workspace with a pre-created Express app, run the following command:
|
|
|
|
```shell
|
|
npx create-nx-workspace --preset=express
|
|
```
|
|
|
|
## Setting Up @nx/express
|
|
|
|
### Installation
|
|
|
|
{% callout type="note" title="Keep Nx Package Versions In Sync" %}
|
|
Make sure to install the `@nx/express` version that matches the version of `nx` in your repository. If the version numbers get out of sync, you can encounter some difficult to debug errors. You can [fix Nx version mismatches with this recipe](/recipes/tips-n-tricks/keep-nx-versions-in-sync).
|
|
{% /callout %}
|
|
|
|
In any Nx workspace, you can install `@nx/express` by running the following command:
|
|
|
|
```shell {% skipRescope=true %}
|
|
nx add @nx/express
|
|
```
|
|
|
|
This will install the correct version of `@nx/express`.
|
|
|
|
## Recipes
|
|
|
|
- [Add an Express Application to Your Workspace](/showcase/example-repos/add-express)
|
|
- [Set Up Application Proxies](/recipes/node/application-proxies)
|
|
- [Wait For Tasks To Finish](/recipes/node/wait-for-tasks)
|