JSPM

  • Created
  • Published
  • Downloads 1607
  • Score
    100M100P100Q119747F
  • License MIT

Deploy an Angular app to Amazon S3 directly from the Angular CLI

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@jefiozie/ngx-aws-deploy) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    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!