omi/packages/omis

Omis

Omi server side rendering

Getting Start

$ npm i omi-cli -g      # install cli
$ omi init-s my-app     # init project
$ cd my-app           
$ npm start             # develop
$ npm run build         # release

Other Cmds

npm start (start.js)

• Cleans up the output /build directory (clean.js)
• Copies static files to the output folder (copy.js)
• Launches Webpack compiler in a watch mode (via webpack-middleware)
• Launches Node.js server from the compiled output folder (runServer.js)
• Launches Browsersync and Hot Module Replacement

npm run build (build.js)

• Cleans up the output /build folder (clean.js)
• Copies static files to the output folder (copy.js)
• Creates application bundles with Webpack (bundle.js, webpack.config.js)

npm run deploy (deploy.js)

• Builds the project from source files (build.js)
• Pushes the contents of the /build folder to a remote server with Git

Options

Flag	Description
--release	Minimizes and optimizes the compiled output
--verbose	Prints detailed information to the console
--analyze	Launches Webpack Bundle Analyzer
--static	Renders specified routes as static html files
--docker	Build an image from a Dockerfile
--silent	Do not open the default browser

For example:

$ npm run build --release --verbose      # Build the app in production mode

or

$ npm start --release                    # Launch dev server in production mode

Misc

• webpack.config.js - Webpack configuration for both client-side and server-side bundles
• postcss.config.js - PostCSS configuration for transforming styles with JS plugins
• run.js - Helps to launch other scripts with babel-node (e.g. babel-node tools/run build)
• .eslintrc - ESLint overrides for built automation scripts

License

MIT © dntzhang

Open Source Software Licensed Under the MIT License:

react-starter-kit Copyright © 2014-present Kriasoft, LLC.