Figuration(link is external)

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

Get started at https://figuration.org/(link is external)!

Table of Contents

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

Status

Latest Release

Development Build Status

Quick Start

Several quick start options are available:

• Download the latest release.(link is external)
• Clone the repo: git clone https://github.com/cast-org/figuration.git
• Install with npm(link is external): npm install figuration@4.3.3
• Install with yarn(link is external): yarn add figuration@4.3.3

Read the Get Started page(link is external) 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(link is external) (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(link is external) and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue(link is external).

Documentation

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

Running Documentation Locally

1. Run npm install to install Node.js dependencies.
2. Run grunt dist (or a specific set of Grunt tasks) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
3. From the root /figuration directory, run npm run docs-serve in the command line.
4. Open http://localhost:9001 in your browser, and enjoy.

Learn more about using Eleventy by reading its documentation(link is external).

Contributing

Please read through our contributing guidelines(link is external). 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(link is external). All HTML and CSS should conform to the coding standards.

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

Community

Keep up with Figuration's development and announcements.

• Follow @figuration_org on Twitter(link is external)

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Figuration is maintained under the Semantic Versioning guidelines(link is external). We might screw up, but we'll try sticking to those rules whenever possible.

Changelog

See the Releases section of our GitHub project(link is external) for changelogs for each release version.

Copyright and License

Code and documentation copyright 2013-2022 CAST, Inc.(link is external) Code released under the MIT license(link is external). Docs released under Creative Commons(link is external).