Add a New Express Project
Supported Features
Because we are using an Nx plugin for Express, all the features of Nx are available.
✅ Run Tasks ✅ Cache Task Results ✅ Share Your Cache ✅ Explore the Graph ✅ Distribute Task Execution ✅ Integrate with Editors ✅ Automate Updating Nx ✅ Enforce Module Boundaries ✅ Use Task Executors ✅ Use Code Generators ✅ Automate Updating Framework Dependencies
Install the Express Plugin
❯
npm i --save-dev @nx/express
Create an Application
Use the app
generator to create a new Express app.
❯
nx g @nx/express:app 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
Once the library is created, update the following files.
1export function someFunction(): string {
2 return 'some function';
3}
4
1/**
2 * This is not a production server yet!
3 * This is only a minimal backend to get started.
4 */
5
6import express from 'express';
7import * as path from 'path';
8
9const app = express();
10
11app.use('/assets', express.static(path.join(__dirname, 'assets')));
12
13app.get('/api', (req, res) => {
14 res.send({ message: 'Welcome to my-express-app!' });
15});
16
17const port = process.env.PORT || 3333;
18const server = app.listen(port, () => {
19 console.log(`Listening at http://localhost:${port}/api`);
20});
21server.on('error', console.error);
22
Now when you serve your API, you'll see the content from the library being displayed.