@jefiozie/ngx-aws-deploy
TypeScript icon, indicating that this package has built-in type declarations

5.1.0 • Public • Published

NGX-AWS-DEPLOY

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

All Contributors

CI npm npm (scoped) GitHub issues
Twitter Follow

ngx-aws-deploy

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. After these steps your angular.json is updated with a new builder:

    "deploy": {
        "builder": "@jefiozie/ngx-aws-deploy:deploy",
        "options": {}
    }
  5. Due to security risk we have made the decision to never add any options to the angular.json. You should set the environments variable during the ng deploy command. Below a example on how you could do this.

npx cross-env NG_DEPLOY_AWS_ACCESS_KEY_ID=1234 NG_DEPLOY_AWS_SECRET_ACCESS_KEY=321ACCESS NG_DEPLOY_AWS_BUCKET=mys3bucket NG_DEPLOY_AWS_REGION=eu-1-region ng deploy
  1. 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 libs\ngx-aws-deployfolder. The sample app is located in the apps\demo-app 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

💻

Zack Yang

💻

David Houseknecht

📖

Brian Harris

📖

Michael Vogl

💻

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

Install

npm i @jefiozie/ngx-aws-deploy

DownloadsWeekly Downloads

1,174

Version

5.1.0

License

MIT

Unpacked Size

55.7 kB

Total Files

27

Last publish

Collaborators

  • jefiozie