nx-serverless-monorepo

A monrepo style, modern boilerplate or template project for Serverless framework using Nx monorepo toolkit 🛠 and aws-nodejs-typescript serverless template

Table of contents

• Whats Included
• Template Layout
• Prerequisites
• Usage
• Further help
• Nx Cloud
• Contribution
• Support
• Maintainer
• License

Whats Included

• A template project layout using latest version of Nx and Servrless framework
• An easy to use workspace generator to generate a template/stack with Serverless framework files and related Nx configuration
• Configured with AWS provider and it can be easily adopted to any cloud provider

Template Layout

.
├── stacks/    # stack for each serverless configuration/template and its associated files
├── libs/      # shared libraries
├── tools/
├── README.md
├── jest.config.js
├── jest.preset.js
├── nx.json
├── package.json
├── serverless.base.ts  # base configuration for serverless
├── tsconfig.base.json
├── workspace.json
├── .editorconfig
├── .eslintrc.json
├── .gitignore
├── .husky              # git hooks
├── .nvmrc
├── .prettierignore
├── .prettierrc

Prerequisites

• Nodejs protip: use nvm

> :warning: Version: lts/iron (v20). If you're using nvm, run nvm use to ensure you're using the same Node version in local and in your lambda's runtime.

• :package: Package Manager
• Yarn
• 💅 Code format plugins
• Eslint
• Prettier
• EditorConfig

> On your preferred code editor, Install plugins for the above list of tools

Usage

Depending on your preferred package manager, follow the instructions below to build and deploy serverless stack(s).

• Install project dependencies

``shell yarn install `

• Generate a new stack

`shell nx g serverless `

> Run with -d or --dry-run flag for dry run

• Generate a new library

`shell nx g @nx/node:lib --skipBabelrc --tags lib `

> Run with -d or --dry-run flag for dry run

• Package stack
• To package a single stack

`shell nx run :build --stage= `

• To package stack affected by a change

`shell nx affected:build --stage= `

• To package all stacks

`shell nx run-many --target=build --stage= `

• Deploy stack to cloud
• To deploy a single stack

`shell nx run :deploy --stage= `

• To deploy the stack affected by a change

`shell nx affected:deploy --stage= `

• To deploy all stacks

`shell nx run-many --target=deploy --all --stage= `

• Remove stack from cloud
• To remove a single stack

`shell nx run :remove --stage= `

• To remove stack affected by a change

`shell nx affected:remove --stage= `

• To remove all stacks

`shell nx run-many --target=remove --all --stage= `

• Run tests
• To run tests in a single stack

`shell nx run :test --stage= `

• To run tests affected by a change

`shell nx affected:test --stage= `

• To run tests in all stacks

`shell nx run-many --target=test --all --stage= `

• Run offline / locally
• To run offline, configure the serverless-offline plugin as documented here and run the command below

`shell nx run :serve --stage= `

• Understand your workspace

` nx dep-graph ``

Further help

• Visit Serverless Documentation to learn more about Serverless framework
• Visit Nx Documentation to learn more about Nx dev toolkit
• Why NX, not Lerna? Lerna is no longer maintained

Nx Cloud

##### Computation Memoization in the Cloud

​ Nx Cloud pairs with Nx in order to enable you to build and test code more rapidly, by up to 10 times.

​ Visit Nx Cloud to learn more and enable it

Contribution

Found an issue? feel free to raise an issue with information to reproduce.

Pull requests are welcome to improve.

Support

Like the template?

Click to

Or, Add a star :star: to the repository

Maintainer

This template is authored and maintained by sudokar

License

MIT

--- Tranlated By Open Ai Tx | Last indexed: 2026-05-27 ---