CAST Figuration: A feature rich, responsive, mobile first, accessible, front-end framework inspired by Bootstrap.
Get started at http://figuration.org/!
Table of Contents
- Quick Start
- Bugs and Feature Requests
- Copyright and License
Several quick start options are available:
- Download the latest release.
- Clone the repo:
git clone https://github.com/cast-org/figuration.git
- Install with npm:
npm install figuration
- Install with yarn:
yarn add figuration
Read the Get Started page for information on the framework, templates, and examples.
Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:
figuration/ +-- dist/ +-- css/ ¦ +-- figuration.css ¦ +-- figuration.min.css ¦ +-- figuration-rtl.css ¦ +-- figuration-rtl.min.css +-- js/ +-- figuration.js +-- figuration.min.js
We provide compiled CSS and JS (
figuration.*), as well as compiled and minified CSS and JS (
figuration.min.*). CSS source maps (
figuration.*.map) are available for use with certain browsers' developer tools.
Bugs and Feature Requests
Running Documentation Locally
- Run through the tooling setup to install Jekyll (the site builder) and other Ruby dependencies with
npm installto install Node.js dependencies.
- From the root
bundle exec jekyll servein the command line.
http://localhost:9001in your browser, and enjoy.
Learn more about using Jekyll by reading its documentation.
Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.
Keep up with Figuration's development and announcements.
- Follow @figuration_org on Twitter
For transparency into our release cycle and in striving to maintain backward compatibility, Figuration is maintained under the Semantic Versioning guidelines. We might screw up, but we'll try sticking to those rules whenever possible.
See the Releases section of our GitHub project for changelogs for each release version.