Package Exports

figuration

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (figuration) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Figuration

CAST Figuration: A feature rich, responsive, mobile first, accessible, front-end framework.

Get started at http://figuration.org/!

This is the v4 development branch, currently in very-early alpha. Not ready for production yet! Check out v3 at the link above!

Status
Quick Start
Bugs and Feature Requests
Documentation
Contributing
Community
Versioning
Changelog
Copyright and License

Status

Latest Release

Dependencies

Development Build Status

Quick Start

Several quick start options are available:

Nothing has been released yet, as this is a development version.

Download the latest release.
Clone the repo: git clone https://github.com/cast-org/figuration.git
Install with npm: npm install figuration@4.0.0-alpha.2
Install with yarn: yarn add figuration@4.0.0-alpha.2

Read the Get Started page for information on the framework, templates, and examples.

What's Included

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

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Documentation

Figurations's documentation, included in this repo in the root directory, is built with Jekyll and publicly hosted on GitHub Pages at http://figuration.org. The docs may also be run locally.

Running Documentation Locally

Run through the tooling setup to install Jekyll (the site builder) and other Ruby dependencies with bundle install.
Run npm install to install Node.js dependencies.
Run grunt (or a specific set of Grunt tasks) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
From the root /figuration directory, run bundle exec jekyll serve in the command line.
Open http://localhost:9001 in your browser, and enjoy.

Learn more about using Jekyll by reading its documentation.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

If your pull request contains JavaScript patches or features, you must include relevant unit tests. All HTML and CSS should conform to the coding standards.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at https://editorconfig.org.

Community

Keep up with Figuration's development and announcements.

Follow @figuration_org on Twitter

Versioning

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.

Changelog

See the Releases section of our GitHub project for changelogs for each release version.

figuration