Add a New Express Project

Supported Features

Because we are using an Nx plugin for Express, all the features of Nx are available.

{% pill url="/core-features/run-tasks" %}✅ Run Tasks{% /pill %} {% pill url="/core-features/cache-task-results" %}✅ Cache Task Results{% /pill %} {% pill url="/core-features/remote-cache" %}✅ Share Your Cache{% /pill %} {% pill url="/core-features/explore-graph" %}✅ Explore the Graph{% /pill %} {% pill url="/core-features/distribute-task-execution" %}✅ Distribute Task Execution{% /pill %} {% pill url="/core-features/integrate-with-editors" %}✅ Integrate with Editors{% /pill %} {% pill url="/core-features/automate-updating-dependencies" %}✅ Automate Updating Nx{% /pill %} {% pill url="/core-features/enforce-module-boundaries" %}✅ Enforce Module Boundaries{% /pill %} {% pill url="/core-features/plugin-features/use-task-executors" %}✅ Use Task Executors{% /pill %} {% pill url="/core-features/plugin-features/use-code-generators" %}✅ Use Code Generators{% /pill %} {% pill url="/core-features/automate-updating-dependencies" %}✅ Automate Updating Framework Dependencies{% /pill %}

Install the Express Plugin

{% 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. {% /callout %}

{% tabs %} {%tab label="npm"%}

npm i --save-dev @nx/express

{% /tab %} {%tab label="yarn"%}

yarn add --dev @nx/express

{% /tab %} {% /tabs %}

Create an Application

Use the app generator to create a new Express app.

{% callout type="note" title="Directory Flag Behavior Changes" %} The command below uses the as-provided directory flag behavior, which is the default in Nx 16.8.0. If you're on an earlier version of Nx or using the derived option, omit the --directory flag. See the workspace layout documentation for more details. {% /callout %}

nx g @nx/express:app my-express-api --directory=apps/my-express-api

Serve the API by running

nx serve my-express-api

This starts the application on localhost:3333/api by default.

Create a Library

The @nx/express plugin does not have a library generator, but we can use the library generator from the @nx/js plugin. To create a new library, install the @nx/js package and run:

nx g @nx/js:lib my-lib --directory=libs/my-lib

Once the library is created, update the following files.

export function someFunction(): string {
  return 'some function';
}

/**
 * This is not a production server yet!
 * This is only a minimal backend to get started.
 */

import express from 'express';
import * as path from 'path';

const app = express();

app.use('/assets', express.static(path.join(__dirname, 'assets')));

app.get('/api', (req, res) => {
  res.send({ message: 'Welcome to my-express-app!' });
});

const port = process.env.PORT || 3333;
const server = app.listen(port, () => {
  console.log(`Listening at http://localhost:${port}/api`);
});
server.on('error', console.error);

Now when you serve your API, you'll see the content from the library being displayed.

3.9 KiB Raw Blame History

Add a New Express Project

Install the Express Plugin

Create an Application

Create a Library

More Documentation

3.9 KiB

Raw Blame History