To get started, check out http://getfuelux.com!
Table of contents
- Bugs and feature requests
- Copyright and license
Fuel UX can be used with an existing page via CDN or installed in a project.
Read the Getting started page for more detailed information on the framework contents, templates, examples, and more.
fuelux class to the portion of the page using Fuel UX as seen here.
Ensure all the dependencies are included on the page (eg, such as using the CDN as shown below).
<link href="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css" rel="stylesheet"> <link href="//www.fuelcdn.com/fuelux/3.14.1/css/fuelux.min.css" rel="stylesheet"> <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.js"></script> <script src="//maxcdn.bootstrapcdn.com/bootstrap/3.2.1/js/bootstrap.min.js"></script> <script src="//www.fuelcdn.com/fuelux/3.14.1/js/fuelux.min.js"></script>
The code you want is in
A few ways available to install.
- Request files from the Fuel UX CDN
- Install with NPM:
npm install fuelux.
- Download the latest release.
- Clone the repo:
git clone https://github.com/exacttarget/fuelux.git.
- Install with Bower:
bower install fuelux.
- Install with Volo:
volo add fuelux.
More details for the above can be found here.
We provide compiled CSS and JS (like
fuelux.*), as well as compiled and minified CSS and JS (like
fuelux.min.*) in the
dist folder. Supporting icons are provided as fonts.
fuelux/ ├── css/ │ ├── fuelux.css │ ├── fuelux.min.css ├── js/ │ ├── fuelux.js │ └── fuelux.min.js └── fonts/ ├── fuelux.eot ├── fuelux.svg ├── fuelux.ttf └── fuelux.woff
For other methods of managing dependencies consider AMD support via require.
Bugs and Feature Requests
For additional assistance connect with the community.
Before writing code
- confirm issue is new, if not, get involved in previous report of issue.
- create a new issue to confirm where your contribution fits into our roadmap.
- Do not edit or commit files in the
distdirectory. Project maintainers will commit files in the
distdirectory from time to time. Details on compiling CSS and JavasScript can be found here.
- Source files are in respective
- Conform to Salesforce Marketing Cloud style guide.
- Add and/or update unit tests for any new or changed functionality.
- Test your code at http://localhost:8000/. (start using
- Run unit tests with
grunt testor in browser at http://localhost:8000/test/ (you'll need to
grunt servefastto keep server from quitting on failed unit tests to troubleshoot in browser).
Submitting Pull Requests
While grunt can run the included unit tests via PhantomJS, this isn't a substitute for running tests across a variety of browsers and environments. Please be sure to test in as many of the browsers listed in
sauce_browsers.yml as you can before contributing.
gruntto lint & test your code.
- Write meaningful commit messages.
- Submit a pull request from your github fork, mentioning the issue your changes fix.
- Follow your pull request answering questions and making adjustments as appropriate until it is merged.
Read more about contributing to FuelUX
Our aim is to provide a suite of related but independent projects that help web developers integrate, manage, and customize quality libraries and utilities to more efficiently develop, maintain, test, and distribute their projects. Any improvements or fixes we make to the open source projects, we use will be contributed upstream if they are useful to the rest of the community.
|Project Maintainers (a-z)|
And thank you to all those that have submitted issues and contributed to this library.
Copyright and License
Copyright © 2012-2014 Salesforce Marketing Cloud, Inc.
View BSD-3 license.