NGX-AWS-DEPLOY
☁️🚀 Deploy your Angular app to Amazon S3 directly from the Angular CLI 🚀☁️
Quick Start
-
Install the latest version of Angular cli
yarn global add @angular/cli
-
Create a new Angular project
ng new hello-world --defaults
cd hello-world
-
Add @jefiozie/ngx-aws-deploy
to your project
ng add @jefiozie/ngx-aws-deploy
-
You will be prompted for a couple of questions:
- Your AWS Region
- The bucket you would like the files to be uploaded.
- The folder where the files should be uploaded (optional)
-
By default we will add the configuration for production setup.
-
After these step your angular.json
is update with a new builder:
"deploy": {
"builder": "@jefiozie/ngx-aws-deploy:deploy",
"options": {
"configuration": "production",
"region": "YOUR REGION",
"bucket": "YOUR BUCKET",
}
-
Run ng deploy
to deploy your application to Amazon S3.
🚀Happy deploying! 🚀
Security 🔑
Keep in mind that with the default config, everybody that has access to the angular.json will have your aws secret.
If you want more security, you can also use environment variable with NG_DEPLOY_AWS_ACCESS_KEY_ID
, NG_DEPLOY_AWS_SECRET_ACCESS_KEY
, NG_DEPLOY_AWS_BUCKET
and NG_DEPLOY_AWS_REGION
.
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
The builder is located in the builder
folder.
The sample app is located in the builder-test
folder.
Please make sure to update tests as appropriate.
License
MIT
Contributors ✨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!