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 consuming app to include the SDK as a static asset or as part of a build process.
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
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.
The unit tests are run by Karma configured to use webpack to transpile and bundle the ES6-compliant Mocha tests.
npm test
This project was inspired by other popular front-end frameworks published under the MIT license:
- Bootstrap copyright 2011-2015 Twitter, Inc.
- Foundation copyright 2015 ZURB, inc.
Copyright 2015 Pearson Education. This software is published under the MIT license.