zack9433 / ngx-aws-deploy

☁️🚀 Deploy your Angular app to Amazon S3 directly from the Angular CLI 🚀☁️

NGX-AWS-DEPLOY

☁️🚀 Deploy your Angular app to Amazon S3 directly from the Angular CLI 🚀☁️

Quick Start

1. Install the latest version of Angular cli

   yarn global add @angular/cli

2. Create a new Angular project

   ng new hello-world --defaults
   cd hello-world

3. Add @jefiozie/ngx-aws-deploy to your project

   ng add @jefiozie/ngx-aws-deploy

4. You will be prompted for a couple of questions:

   1. Your AWS Region
   2. The bucket you would like the files to be uploaded.
   3. The Secret Access Key
   4. The Access key Id

5. After these step your angular.json is update with a new builder:

   "deploy": {
       "builder": "@jefiozie/ngx-aws-deploy:deploy",
       "options": {
       "region": "YOUR REGION",
       "bucket": "YOUR BUCKET",
       "secretAccessKey": "YOUR SECRET ACCESSKEY",
       "accessKeyId": "YOUR ACCESS KEY ID"
       }
   }

6. 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 builderfolder. 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):

Jeffrey Bosch 💻 🖋 👀

Santosh Yadav 💻

Nicolas Beaussart 💻

Stefan Nieuwenhuis 💻

This project follows the all-contributors specification. Contributions of any kind welcome!