CLI tool to deploy React App to S3 and CloudFront
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
blueprints/react-deploy
build
img
lib
node-tests
tests
vendor
.babelrc
.editorconfig
.eslintrc.js
.gitignore
.npmignore
.travis.yml
.watchmanconfig
LICENSE
README.md
codecov.yml
index.js
package-lock.json
package.json
testem.json

README.md

react-deploy-cli

GitHub issues GitHub forks GitHub stars GitHub license codecov Build Status Twitter

Deploy react app to s3 and Cloudfront with versioning and activation features.

                              _                 _                  _                 
  _ __    ___    __ _    ___  | |_            __| |   ___   _ __   | |   ___    _   _ 
 | '__|  / _ \  / _` |  / __| | __|  _____   / _` |  / _ \ | '_ \  | |  / _ \  | | | |
 | |    |  __/ | (_| | | (__  | |_  |_____| | (_| | |  __/ | |_) | | | | (_) | | |_| |
 |_|     \___|  \__,_|  \___|  \__|          \__,_|  \___| | .__/  |_|  \___/   \__, |
                                                           |_|                  |___/ 

This package doesn't build the app, instead use webpack or create-react-app to build your application instead.

Table of Contents

Install

npm i -g react-deploy-cli

# or

yarn global add react-deploy-cli

Usage

react-deploy

 Usage: react-deploy [options] [command]


  Commands:

    setup                 run deployment configuration file
    deploy [env]          deploy code to s3 bucket with specific environment
    list [env]            list deployed version from s3
    activate <key> [env]  activate version with or specific environment

  Options:

    -h, --help     output usage information
    -V, --version  output the version number



To initialize setup file for react-deploy , go inside your react app project root directory and use following command

react-deploy setup

                               _                 _                  _                 
  _ __    ___    __ _    ___  | |_            __| |   ___   _ __   | |   ___    _   _ 
 | '__|  / _ \  / _` |  / __| | __|  _____   / _` |  / _ \ | '_ \  | |  / _ \  | | | |
 | |    |  __/ | (_| | | (__  | |_  |_____| | (_| | |  __/ | |_) | | | | (_) | | |_| |
 |_|     \___|  \__,_|  \___|  \__|          \__,_|  \___| | .__/  |_|  \___/   \__, |
                                                           |_|                  |___/ 

Result:


✓ Deployment file created

➡  Type help command to proceed further


It will automatically create a deploy.js file. Now inside deploy.js file put your s3 bucket name, along with ACCESSKEYID and SECERETKEY.

After building your react app. It's time to deploy your app to S3 bucket.

react-deploy deploy development


Checking configuration file

Result:

Starting 'upload:development'...
Finished 'upload:development' after 1ms

Revision created successfuly

It will upload your assests to the s3 bucket with uniquely generated file name. upload revisions

In order to get revision of deployed files we use list command.

react-deploy list development


Checking configuration file
Result:
Starting 'list:development'...
Finished 'list:development' after 4ms
┌───────────────────┬──────────────────────────────┐
│ RevisionKey       │ Commit Date                  │
├───────────────────┼──────────────────────────────┤
│   index:01403ec   │ 2018/04/04 14:26:29          │
├───────────────────┼──────────────────────────────┤
│   index:527cd76   │ 2018/04/04 14:34:49          │
├───────────────────┼──────────────────────────────┤
│   index:6993120   │ 2018/04/04 14:09:03          │
├───────────────────┼──────────────────────────────┤
│   index:fa51993   │ 2018/04/04 15:41:51          │
└───────────────────┴──────────────────────────────┘
 

To activate a specific version use the activate command followed by key.

react-deploy activate fa51993 development

Checking configuration file
Result:
Starting 'activate:fa51993'...
Finished 'activate:fa51993' after 6ms
Activating index file of key fa51993
Activating service-worker file of key fa51993
Revision activated successfully
Revision activated successfully

Contribute

Contributors are welcome. Small note: If editing the README, please conform to the standard-readme specification.

License

MIT © sumn2u