Modern Serverless framework starter template using Nrwl Nx monorepo dev toolkit
A monrepo style, modern boilerplate or template project for Serverless framework using Nx monorepo toolkit 🛠and aws-nodejs-typescript
serverless template
.
├── 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
:warning: Version:
lts/iron (v20)
. 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: Package Manager
💅 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
yarn install
Generate a new stack
nx g serverless <STACK_NAME>
Run with
-d
or--dry-run
flag for dry run
Generate a new library
nx g @nx/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 command
nx run <STACK_NAME>:serve --stage=<STAGE_NAME>
Understand your workspace
nx dep-graph
​ 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 :star: to the repository
This template is authored and maintained by sudokar
MIT