For full documentation, please visit https://pearson-elements-v0.surge.sh/getting-started/
We recommend that you install Elements in your project using npm:
npm install --save pearson-elements
The installation provides both the dist version with CSS, and the original source SCSS, with required assets. This allows the option for the consuming app to include the SDK as a static asset or as part of a build process.
The Elements SDK looks for the /fonts folder at the root of your served application. Copy the npm-installed /fonts to the correct location in your web server, and ensure your application is set up to allow the font files to download correctly and not filter out the response header Content Type (i.e. 'application/x-font-ttf') so the icons may be rendered in the browser.
Please review the guidelines for contributing before getting started.
You must have Node.js v5 installed.
Clone the project and install the dependencies:
git clone https://github.com/Pearson-Higher-Ed/elements.git
cd elements
npm install
Please follow the steps outlined in the how-to-add-an-icon file to add an icon. This assumes the icon is a Font-Awesome icon and was already approved by UX Design (contact the Elemental Design Google Group).
We use Metalsmith to generate the documentation.
npm start
This will give you a browser-sync served copy of the docs on http://localhost:3000, and build the latest version of elements.min.css to /dist.
Forked repo will not trigger the 'ux-test-platform' tests. In the logs, you would see this error: {"error":"Travis encountered an error, sorry :("} which may cause the elements build to fail.
To handle this, follow below steps to have successful build runs:
cd elements
travis login --org *Provide your github login and password
travis token --org *Copy the access token
travis encrypt AUTH_TOKEN=access_token *Copy this token and replace it with env: global: secure: <<access_token>> in .travis.yml file
Push this change and the ux-test-platform build would be triggered successfully.
This project was inspired by other popular front-end frameworks published under the MIT license:
- Bootstrap copyright 2011-2016 Twitter, Inc.
- Foundation copyright 2016 ZURB, inc.
Copyright 2016 Pearson Education. This software is published under the MIT license.