nagyist / sforce-uix.design-system-starter-kit

Rapid prototyping environment using the Salesforce Lightning Design System

Lightning Design System Starter Kit

Rapid prototyping environment using the Salesforce Lightning Design System, HTML, and Sass.

Who is this for?

From the prototyper to the large application developer… the Design System Starter Kit is a helpful tool to get started and run prototypes of all sizes in the browser.

Designers

The starter kit is built using web standards, more specifically HTML and CSS. Copy and pasting markup from https://www.lightningdesignsystem.com/ is quick and easy. No need to be a front-end guru to start designing in the browser!

Salesforce Developers

Setting a whole demo org for a quick prototype can take time and effort, whereas cloning the starter kit and putting a few components together only takes a few minutes. Deploying your prototype to Heroku for free – in only 2 clicks – is also lightning fast!

Quick Start

Pre-requisites: Node.js 4.2 or up.

1. Fork the repository
2. Clone it onto your computer
3. Run npm install
4. Run npm run dev (or gulp)
5. Open http://localhost:3000

That’s it! You can start by editing the src/views/index.html file and build awesome prototypes.

Deploy to Heroku

Deploy your own prototype for free to Heroku in only 2 clicks.

Your work is confidential? Fill in a username and password in the Heroku settings.

What’s inside?

• SLDS Components and CSS, imported using Sass
• Powerful templating using Nunjucks
• Some JavaScript, making a few components interactive
• SVG4Everybody, a polyfill that helps browsers display SVG icons
• Live reload using BrowserSync: automatic browser reloading on file changes, and simultaneous cross-device testing
• Sourcemaps support (for live in-browser Sass development)
• Autoprefixer (adds vendor prefixes to CSS rules)

FAQ

Which browsers does the Starter Kit support?

When it comes to the CSS, the Starter Kit has the same support level as the Lightning Design System itself. See the list of supported browsers.

For JavaScript, at the moment only a few very recent browsers are supported (Chrome & Firefox recommended).

Is there a showcase of prototypes using the Starter Kit?

Not yet, but we’d love to know about your creations! Feel free to get in touch in the issues of the project. In the mean time, you can check out the example prototype.

See Also

The Design System UI Kit is a great way for designers to put beautiful static prototypes together.

Using React? Check out the react branch (beta)!

---

License

Copyright (c) 2016, salesforce.com, inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of salesforce.com, inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.