Code Monkey home page Code Monkey logo

ngx-aws-deploy's Introduction

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 is an 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_AWS_SUB_FOLDER=path/on/bucker 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!

ngx-aws-deploy's People

Contributors

jefiozie avatar arturovt avatar dependabot-preview[bot] avatar dependabot[bot] avatar allcontributors[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.