\n\n\n\n# What is @flowaccount/nx-serverless\n\nπ **Extensible Continous Delivery/Depolyment Tools on top of Nx workspace for Serverless Framework. Because managing multiple lambda in one repository is an awesome thing!**\n\n## Our Mission\n\nSimplify any workflow that can be abstracted into one command using the same configuration structure as `workspace.json/angular.json`. Make development life-cycle easier, more effective and having less rituals. Communications through configurations and not documentations.\n\n**join our community** [@flowaccount/community](https://join.slack.com/t/flowaccountcommunity/shared_invite/zt-10dw6janp-JVE7k6y7OXf8ET9t2Y2BKQ)\n\n## Feature sets to support for Serverless Framework\n\n### Frameworks Schematics\n\n| Framework Name | AWS |\n| -------------------------------- | ------------------ |\n| Node-Typescript (Webpack) | :white_check_mark: |\n| :white_check_mark: | :calendar: |\n| Express-js (Typescript-compiler) | :white_check_mark: |\n\n### Serverless Framework Commands\n\n| Command Names | AWS |\n| ------------------ | ------------------ |\n| Deploy | :white_check_mark: |\n| Destroy | :white_check_mark: |\n| Sls Command | :white_check_mark: |\n| Serverless-offline | :white_check_mark: |\n\n### Supported Serverless Framework Versions\n\n| Versions | Status |\n| -------- | ------------------ |\n| 1.0+ | :white_check_mark: |\n| 2.0+ | :white_check_mark: |\n\n### Builders wrapped before packaging/deployment\n\n| Builder Names | |\n| ------------------- | ------------------ |\n| Webpack compiler | :white_check_mark: |\n| Typescript compiler | :white_check_mark: |\n\nWhats special about the plugin is that, you **DO NOT** need to use `serverless-wepack` or `serverless-typescript` plugins anymore! The library uses angular builders to _build_ or typescript compilers to _compile_ your code for you into javascript before _packaging_ them into a zip file and _deploy_ them to the serverless cloud.\n\n### Package.json dependency resolvers\n\n| Resolver Names | |\n| -------------- | ------------------ |\n| Webpack stats | :white_check_mark: |\n| Depcheck | :white_check_mark: |\n\nThe other special thing that the library does is, it uses `webpack stats` to build up your `dependencies` and write a `package.json` into your `dist` folder in the attempt to minimize the amount of `dependencies` in your `node_modules` needed to be uploaded to the cloud.\n\nFor typescript compilers it uses `dep-checks` to resolve the dependencies and write up a `package.json` file\n\n## Getting Started\n\n### To Deploy an Existing Angular Application adding Ng-Universal in the process\n\nFirst you need to create an nx workspace to get started!\n\n## Using npx\n\n```bash\nnpx create-nx-workspace # Then you got to use yarn/npm\n// if start with angular presets\nnx add @flowaccount/nx-serverless # or with these options --project=my-app --provider=aws --addUniversal=yes\n// else\nnpm install @flowaccount/nx-serverless --save-dev\n```\n\n## Using npm\n\n```bash\nnpm init nx-workspace\n// if start with angular presets\nnpm run nx add @flowaccount/nx-serverless # or with these options --project=my-app --provider=aws --addUniversal=yes\n// else\nnpm install @flowaccount/nx-serverless --save-dev\n```\n\n## Using yarn\n\n```bash\nyarn create nx-workspace\n// if start with angular presets\nyarn nx add @flowaccount/nx-serverless # or with these options --project=my-app --provider=aws --addUniversal=yes\n// else\nyarn add --dev @flowaccount/nx-serverless\n```\n\n## Deploying/Compiling application (Assuming you have nx added globally, otherwise use npx/npm/yarn!)\n\n```bash\nnx run my-app:offline # to run the universal app offline checking serverless works locally\nnx deploy my-app # to deploy the app\nnx run my-app:destroy # to destroy the app\nnx run my-app:compile # to compile only the serverless part of the app\n```\n\n## Running custom sls commands application (Assuming you have nx added globally, otherwise use npx/npm/yarn!)\n\n```bash\nnx run my-app:sls # to run the custom sls commands as per what you need!\n```\n\n## To Create and Deploy Node-Typescript Serverless Application\n\n**Using npx**\n\n```bash\nnpx create-nx-workspace # Then you got to use yarn/npm\nnx g @flowaccount/nx-serverless:api-serverless --name=myapi --provider=aws\n```\n\n**Using npm**\n\n```bash\nnpm init nx-workspace\nnx g @flowaccount/nx-serverless:api-serverless --name=myapi --provider=aws\n```\n\n**Using yarn**\n\n```bash\nyarn create nx-workspace\nnx g @flowaccount/nx-serverless:api-serverless --name=myapi --provider=aws\n```\n\n**Deploying/Compiling application (Assuming you have nx added globally, otherwise use npx/npm/yarn!)**\n\n```bash\nnx serve myapi --port=7777 # to serve the api locally on port 7777\nnx deploy myapi --stage=dev# to deploy the api\nnx build myapi # to build the api\n```\n\n**To Debug your deployments**\nEdit the `env.json` files generated by the schematics. change `SLS_DEBUG` to `true`\n\n## To ship your assets (html,css,js,img etc)\n\n```json\n \"assets\": [\n \"apps/app/src/favicon.ico\",\n \"apps/app/src/robots.txt\",\n \"apps/app/src/manifest.webmanifest\",\n {\n \"glob\": \"**/*\",\n \"input\": \"libs/shared/ui-theme/assets\",\n \"output\": \"./assets\"\n }\n ],\n```\n\n## For Node-Typescript Api Application\n\nthe resulting file tree will look like this:\n\n```bash\n/\nβββ apps/\nβ βββ myapi/\n| βββββββββsrc/handler.ts\n| βββββββββjest.config.js\n| βββββββββtsconfig.json\n| βββββββββserverless.yml\n| βββββββββtsconfig.app.json\n| βββββββββtsconfig.spec.json\n| βββββββββtslint.json\nβββ libs/\nβββ tools/\nβββ nx.json\nβββ package.json\nβββ tsconfig.json\nβββ tslint.json\n```\n\nyou workspace.json will be added with these\n\n```json\n\"build\": {\n \"builder\": \"@flowaccount/nx-serverless:build\",\n \"configurations\": {\n ...\n },\n \"options\": {\n ...\n }\n},\n\"deploy\": {\n \"builder\": \"@flowaccount/nx-serverless:deploy\",\n \"options\": {\n \"waitUntilTargets\": [\"myapi:some-other-builder\"],\n \"buildTarget\": \"myapi:build:production\",\n \"config\": \"apps/myapi/serverless.yml\",\n \"location\": \"dist/static/apps/myapi\",\n \"package\": \"dist/static/apps/myapi\"\n },\n \"configurations\": {\n \"staging\": {\n \"buildTarget\": \"myapi:build:staging\",\n \"waitUntilTargets\": [\"myapi:some-other-builder:staging\"],\n \"stage\": \"staging\"\n },\n \"production\": {\n \"buildTarget\": \"myapi:build:production\",\n \"waitUntilTargets\": [\"myapi:some-other-builder:production\"],\n \"stage\": \"production\"\n }\n }\n},\n\"destroy\": {\n \"builder\": \"@flowaccount/nx-serverless:destroy\",\n \"options\": {\n ...\n }\n},\n\"sls\": {\n \"builder\": \"@flowaccount/nx-serverless:sls\",\n \"options\": {\n ...\n }\n }\n}\n\"lint\": {\n \"builder\": \"@angular-devkit/build-angular:tslint\",\n \"options\": {\n ...\n }\n},\n\"serve\": {\n \"builder\": \"@flowaccount/nx-serverless:offline\",\n \"configurations\": {\n ...\n },\n \"options\": {\n ...\n }\n},\n\"test\": {\n \"builder\": \"@nx/jest:jest\",\n \"options\": {\n ...\n }\n }\n}\n```\n\n## For Expressjs/Angular Universal Application\n\nthe resulting file tree will look like this:\n\n```bash\n/\nβββ apps/\nβ βββ my-app/\n| ββββββββββββββββhandler.ts\n| ββββββββββββββββserverless.yml\n| ββββββββββββββββtsconfig.serverless.json\nβββ libs/\nβββ tools/\nβββ nx.json\nβββ package.json\nβββ tsconfig.json\nβββ tslint.json\n```\n\nThe existing angular project in workspace.json/angular.json will be updated with these sections\n\n```json\n\"compile\": {\n \"builder\": \"@flowaccount/nx-serverless:compile\",\n \"configurations\": {\n ...\n },\n \"options\": {\n ...\n }\n},\n\"deploy\": {\n \"builder\": \"@flowaccount/nx-serverless:deploy\",\n \"options\": {\n ...\n }\n},\n\"destroy\": {\n \"builder\": \"@flowaccount/nx-serverless:destroy\",\n \"options\": {\n ...\n }\n},\n\"offline\": {\n \"builder\": \"@flowaccount/nx-serverless:offline\",\n \"configurations\": {\n ...\n },\n \"options\": {\n ...\n }\n }\n}\n\"sls\": {\n \"builder\": \"@flowaccount/nx-serverless:sls\",\n \"options\": {\n \"waitUntilTargets\": [],\n \"buildTarget\": \"my-app:build:production\",\n \"config\": \"apps/my-app/serverless.yml\",\n \"location\": \"dist/apps/my-app\",\n \"package\": \"dist/apps/my-app\",\n \"command\": \"package\",\n },\n \"configurations\": {\n \"deploy-dev\": {\n \"buildTarget\": \"my-app:build:dev\",\n \"command\": \"deploy\",\n \"stage\": \"dev\"\n },\n \"deploy-production\": {\n \"buildTarget\": \"my-app:build:production\",\n \"command\": \"deploy\",\n \"stage\": \"prod\"\n }\n }\n }\n```\n\n## Want to help?\n\nYou are most welcome to help! Please file a bug or submit a PR, read the [guidelines for contributing](https://github.com/flowaccount/nx-plugins/blob/master/CONTRIBUTING.md) and start right on!\n","readmeFilename":"README.md"}
![](\"https://raw.githubusercontent.com/nrwl/nx/master/nx-logo.png\"){kind=logo}
\n![](\"https://res.cloudinary.com/practicaldev/image/fetch/s--ipV6F4tM--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_880/https://raw.githubusercontent.com/serverless/assets/master/Icon/Framework/PNG/Serverless_Framework-icon01.png\"){kind=icon}
\n![](\"https://upload.wikimedia.org/wikipedia/commons/d/d9/Node.js_logo.svg\"){kind=logo}
\n