:rocket: A quick way to prototype and build apps with React and Babel with zero-setup.
A quick way to prototype and build apps with React and Babel with zero-setup.
Tip: You can add
?transpile=falseto the script src to skip the transpilation.
Quik also exposes a
koamiddleware which can be easily integrated with your server.
You need at least Node 7.0 to run
npm install --global quik
Open the Terminal in any directory and run the following,
It'll start a simple server which will serve the files in the current directory. By default, it'll automatically watch the file
index.htmlfile is present, it'll generate and serve an HTML file with it's script tag pointing to
index.jsfile. Alternatively, you can specify the name of the script to include,
quik --run script.js
If you want to use a different port. For example, to run the server in the port
quik --port 8008
You can include any ES2015 file in a script tag in an HTML file and the script will be transpiled to ES5 on the fly. You can use JSX and Flow syntax as well as use ES2015 modules to import other scripts. It just works.
NOTE: You'll need to install any dependencies you use in the project manually.
Hot Module Replacement for React Components is automatically enabled if you have a script named
index.jsin the directory, or if you specified a script to run with the
--runoption, for example,
quik --run app.js
Alternatively, you can specify the filenames you want to watch for HMR,
quik --watch file1.js file2.js
When using the
index.htmlfile is always generated on the fly and served. If you want to use your own
index.htmlfile, just use
You only need to specify the entry points, not all scripts. Most of the time it'll be just one script. Note that Hot Module Replacement won't work for any components in the entry points.
The bundler provides an abstraction on top of webpack with sensible defaults for a React project. If you need additional customisation, use
webpackdirectly for bundling.
To generate a bundle wth
quikfor use in your web application, run the following in a Terminal,
quik --bundle entry.js --output bundle.js --production
--productionoption performs minification on the resulting bundle. You can omit it if you're not going to use the file in production.
You can provide multiple entry points as arguments. In that case, you can use
[name]to get the name of the entry point while specifying an output file,
quik --bundle file1.js file2.js --output [name].bundle.js --common common.bundle.js
Sourcemap files are automatically generated when generating bundles.
Sometimes you might want compile and inject bundles into an HTML file for easier sharing through dropbox, email etc. To do so, run the following in a Terminal,
quik --html --output output.html --production
You can also specify an HTML file, which
quikwill parse for any local scripts. Then it will build them and inject into the HTML file. It'll also inline stylesheets as is, without any pre-processing. Just open the generated HTML file in any browser to preview.
quik --html index.html --output output.html
You can specify which browser to open when server starts. Refer opn's documentation on browser names.
For example, to use firefox as the browser, you'd do,
quik --browser firefox
To get started with a sample project, run the following in a Terminal,
quik --init AwesomeProject cd AwesomeProject && quik
Refer the API documentation for more to know how to customize and extend the server.
quikmiddleware is just an abstraction on top of
webpack. It includes a base
webpackconfig and generates appropriate config files when needed. For example, when the
webpackconfig on the fly, the file is then transpiled with
webpack, and the server responds with the generated bundle instead of the original script.
The following posts inspired me to work on
One good thing about
quikis that it is highly opinionated, which means we don't worry about becoming generic and can focus on making it better at what it does. It doesn't allow additional
babeltransforms, or loaders for
webpackas of now.
Inline styles are recommended for styling. When combined with a library like
radium, they provide much more flexibility than CSS.
The goal of
quikis to improve the tooling around React and Babel projects. While it'll be easy enough to support additional customization, it defeats the whole purpose of being zero-setup. If you need additional configuration, it will be better to go with
webpackdirectly. If you think something should be included by default, send a pull request or file a bug report.
quikitself doesn't provide additional customization, it's just a
koamiddleware at the core. That means it's composable with other koa middlewares and you can add additional functionality easily.
Below are some ideas on how to improve
quik. It would be awesome to receive pull requests for these.
quikis not the only tool trying to solve this problem. There are few other tools which are also doing a great job at it.
quik, has Hot Module Replacement and can also build bundles for production
browserify, zero-setup, has live-reload functionality