nx-deploy-it

@dev-thought/nx-deploy-it

Version compatibility

NX Version	Nx Deploy It
>= 11.x.x	2.x.x
< 11	1.x.x

Deploy applications in nx / angular workspaces to the cloud using a provider of your Choice (Azure, AWS, Google Cloud Platform)

We are using under the hood the code as infrastructure tool Pulumi. It gives you the possibility to have every piece of code under your control. You can extend it with your requirements (VPN, ...) and still able to use the schematics for deployment.

Quick-start

1. Create a new project with the nx cli.

   npx create-nx-workspace@latest hello-world --preset="angular-nest" --appName="hello-world" --style="scss"
   cd hello-world

2. Add nx-deploy-it to your project. The tool will search for supported applications and ask you which one of them you want to setup. You may be prompted to answer some questions for the setup.

   npx ng add @dev-thought/nx-deploy-it

3. Switch to local state management.

   npx pulumi login --local

4. Deploy your project to your cloud provider.

   npx ng run hello-world:deploy

   The project will be built with the development configuration. In development you will be asked to confirm the changes of your infrastructure

5. Everything is done and you want to remove your whole infrastructure. No problem ;) Just do it with

   npx ng run hello-world:destroy

You can initialize any time infrastructure as code for your project if you skipped the setup on ng add.

npx ng g @dev-thought/nx-deploy-it:init

Requirements

You will need the Angular CLI, an Angular project, and an Azure Subscription to deploy to Azure. Details of these requirements are in this section.

‼️ Cloud provider setup

nx-deploy-it is only working with already configured cloud providers. If you need to know how to set up them, please follow the first steps in the Pulumi Quickstart for your provider.

Infrastructure as code and their state

As many things in development, infrastructure as code needs to hold a state somewhere. This is how the tools can check if something has changed and to do only updates where it is necessary. Pulumi provides different ways to hold the state. The simplest way at the beginning is to hold it local. It's perfect for your local development. Since you want to share it with multiple colleagues or to feel better if it is not only on your disk, you might think about a persistent solution in the cloud with your provider, which you can choose here or with Pulumi self. You can read more about it here. nx-deploy-it installs pulumi as binary in your node_modules folder so you can use it with npx easy.

Azure

If you don't have an Azure subscription, create your Azure free account from this link. https://www.pulumi.com/docs/intro/cloud-providers/azure/setup/

AWS

https://www.pulumi.com/docs/intro/cloud-providers/aws/setup/

Google cloud platform

https://www.pulumi.com/docs/intro/cloud-providers/gcp/setup/

Application / Feature Lists

Legend

• ✅ is implemented
• 🔜 in development
• 📆 in planning
• ❌ is not supported

Workspaces

Nx workspace (native & angular)	angular
Nx	Ng

Angular / React Application

Feature	Azure	AWS	GCP	Workspace	activated in dev (default)	activated in prod (default)
static hosting	✅	✅	✅ (only with custom domain)	Nx, Ng	yes	yes
cdn	✅	✅	✅	Nx, Ng	no	yes
custom domain	✅	✅	✅	Nx, Ng	no (GCP yes)	no (GCP yes)

Custom domains need some manual configuration step. You need to verify them for the providers.

Azure custom domain setup

To verify your custom domain you need to create a CNAME record in your DNS settings. You can read about more about it here. Azure only allows a set of characters. So the . in your custom domain name will be replaced with a -. If your custom domain is www.example.com then your cdn name will be www-example-com.azureedge.net.

HINT: Current limitation: domain name must have maximum 50 characters

GCP custom domain setup

Verify owner: Google makes it really easy. You can use the google webmaster. Add CNAME entry: https://cloud.google.com/storage/docs/hosting-static-website

AWS custom domain setup

For AWS we need to create first a hosted zone with the domain name e.g.: if your domain is www.my-domain.com than use the name my-domain.com for the hosted zone. After this is done you get name servers. Now you can replace the name servers from your domain with the one from aws and you have everything under conrtol via AWS route 53. The rest will be done by nx-deploy-it. It will create the ssl certification and validates if you are the owner of the domain. You can create the hosted zone in the Route53 Service

Angular Universal Application

Only supports native @nguniversal

Feature	Azure	AWS	GCP	Workspace	Supported integration
serverless	✅	✅	✅	nx	@nguniversal/express-engine
server instance	📆	📆	📆	📆

NestJS & ExpressJS

Feature	Azure	AWS	GCP	Workspace
serverless	✅	✅	✅	Nx
server instance	📆	📆	📆	📆

If you use the nx workspace or angular workspace with other types of applications and you want to have them supported by nx-deploy-it, please feel free and create a new Issue and of course ;) -> Contributions are welcome!

Migration from old ng-deploy-it

1. Remove the old package npm uninstall @dev-thought/ng-deploy-it from your package.json

2. Install the new package npm i @dev-thought/nx-deploy-it -D and skip the auto scan of the applications by not selecting an application

3. Rename everything in your repository from ng-deploy-it to nx-deploy-it.