openfin-js-cli openfin js app scaffolding client

   ___                    __ _             _ ____  
  / _ \ _ __   ___ _ __  / _(_)_ __       | / ___| 
 | | | | '_ \ / _ \ '_ \| |_| | '_ \   _  | \___ \ 
 | |_| | |_) |  __/ | | |  _| | | | | | |_| |___) |
  \___/| .__/ \___|_| |_|_| |_|_| |_|  \___/|____/ 
       |_|                                         
  v1.1.0

  albert li personal cli to generate boilerplate codes

  SYNOPSIS
      $ openfin-js react-app <app name>
      $ openfin-js react-app-pro <app name>
      $ openfin-js react-comp <component name>
      $ openfin-js react-view <view component name>
      $ openfin-js react-lyt <layout component name>
      $ openfin-js help
  DESCRIPTION
      --force -f          Create the target file by force, override if any already exist
      --directory -d      Override the default path where the file created
      --verbose -v        Include comments
      --skipInstall       Skip to install node_moduels

Complete Documentation

Installation

    npm install openfin-js-cli -g
    or 
    yarn global add openfin-js-cli

create openfin react app

To generate an openfin template based on create-react-app in typescript

    $ openfin-js openfin-react MyApp    

or

    $ openfin-js openfin-react sample-openfin-react-ts-app -v --skipInstall    

• -v or --verbose will log the files created
• --skipInstall will skip the node_module processes

create openfin react app pro

To generate an openfin template based on create-react-app in typescript of pro version Openfin react app pro will have full setup to support all features provided by template.

    $ openfin-js openfin-react-pro MyProApp    

or

    $ openfin-js openfin-react-pro sample-openfin-react-ts-app -v --skipInstall    

• -v or --verbose will log the files created
• --skipInstall will skip the node_module processes

Configuration and scripts for react apps (concise & pro )

Once generated , the template project will have original tasks forked from create-react-app/scripts plus additional tasks to simply openfin app development.

npm start or yarn start

Runs the app in development mode. Open http://localhost:3000 to view it in the browser.

npm start-openfin or yarn start-openfin

Runs the app in development mode. Meanwhile also start a openfin connection to loaded development codes.

npm test or yarn test

Runs the test watcher in an interactive mode. By default, runs tests related to files changed since the last commit.

npm run build or yarn build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

Your app is ready to be deployed.

npm serve or yarn serve

Servers the app from built folder. Open http://localhost:8080 to view it in the browser.

npm serve-openfin or yarn serve-openfin

Servers the app from built folder. Meanwhile also start a openfin connection to loaded built codes.

npm package or yarn package

Package the app into binary and put to package folder.

##Thanks to the awesome projects depended

Thanks to the awesome projects which make this client possible. And this client does nothing but bundle those together.

###create-react-app ###material-ui ###OpenFin