Flocking ships with pre-built development and production files in the dist directory. For most users, it's suitable to simply load flocking-all.min.js in your HTML file.
For more advanced users, however, Flocking includes a build system that takes care of linting, concatenating, minifying, and organizing the Flocking source tree. The build system is powered by Grunt.
The build system will generate a single file that is easy to include in your web page. Before you start, you'll need to have Node.js installed. Flocking supports the latest Node.js LTS release. Once you've installed it, you simply need to install Flocking's depedencies and then run grunt.
Install grunt and related dependencies:
npm install -g grunt-cli
npm install
To make a build, simply run:
grunt
And then link to the Flocking file in your HTML:
<script src="flocking/dist/flocking-all.js"></script>
| Filename | Description |
|---|---|
flocking-all.js |
All of Flocking and all its dependencies. Use this file if you're not using a module loader and want a simple way to link Flocking into your web page. |
flocking-no-jquery.js |
All of Flocking's dependencies except jQuery. This build is CommonJS/AMD/CMD/whatever module system friendly. |
flocking-base.js |
This build doesn't include include any view-related code whatsoever. You must provide your own builds of Infusion and jQuery. It also does not contain any unit generators beyond the basic set. Use this if you want to choose which unit generators to ship with your application, and if you don't intend to use Flocking's UI components, Infusion Views, or jQuery for access to the DOM. This build is also not compatible with browser-based module loaders. |