A monrepo style, modern boilerplate or template project for Serverless framework using Nx monorepo toolkit ๐ and aws-nodejs-typescript
serverless template
- Whats Included
- Template Layout
- Prerequisites
- Usage
- Further help
- Nx Cloud
- Contribution
- Support
- Maintainer
- License
- 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
.
โโโ 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
-
Nodejs
protip: use nvm
โ ๏ธ Version:lts/gallium (v16)
. If you're using nvm, runnvm use
to ensure you're using the same Node version in local and in your lambda's runtime. -
๐ฆ Package Manager
-
(or)
-
NPM
Pre-installed with Nodejs
-
-
๐ Code format plugins
On your preferred code editor, Install plugins for the above list of tools
Depending on your prefrered package manager, follow the instructions below to build and deploy serverless stack(s).
-
Install project dependencies
-
Using NPM
npm i
-
Using Yarn
yarn
-
-
Generate a new stack
nx workspace-generator serverless <STACK_NAME>
Run with
-d
or--dry-run
flag for dry run -
Generate a new library
nx g @nrwl/node:lib --skipBabelrc --tags lib <LIBRARY_NAME>
Run with
-d
or--dry-run
flag for dry run -
Package stack
-
To package single stack
nx run <STACK_NAME>:build --stage=<STAGE_NAME>
-
To package stack affected by a change
nx affected:build --stage=<STAGE_NAME>
-
To package all stacks
nx run-many --target=build --stage=<STAGE_NAME>
-
-
Deploy stack to cloud
-
To deploy single stack
nx run <STACK_NAME>:deploy --stage=<STAGE_NAME>
-
To deploy stack affected by a change
nx affected:deploy --stage=<STAGE_NAME>
-
To deploy all stacks
nx run-many --target=deploy --all --stage=<STAGE_NAME>
-
-
Remove stack from cloud
-
To remove single stack
nx run <STACK_NAME>:remove --stage=<STAGE_NAME>
-
To remove stack affected by a change
nx affected:remove --stage=<STAGE_NAME>
-
To remove all stacks
nx run-many --target=remove --all --stage=<STAGE_NAME>
-
-
Run tests
-
To run tests in single stack
nx run <STACK_NAME>:test --stage=<STAGE_NAME>
-
To run tests affected by a change
nx affected:test --stage=<STAGE_NAME>
-
To run tests in all stacks
nx run-many --target=test --all --stage=<STAGE_NAME>
-
-
Run offline / locally
-
To run offlline, configure
serverless-offline
plugin as documented here and run below commandnx run <STACK_NAME>:serve --stage=<STAGE_NAME>
-
-
Understand your workspace
nx dep-graph
- 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 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
Found an issue? feel free to raise an issue with information to reproduce.
Pull requests are welcome to improve.
Like the template?
Or, Add a star โญ to the repository
This template is authored and maintained by sudokar
MIT