Vlocity Newport Design System

Welcome to the Vlocity Newport Design System brought to you by Vlocity.

Tailored for building Vlocity Newport apps: Using the Newport Design System markup and CSS framework results in UIs that reflect the Vlocity Newport look and feel.
Based on the Salesforce Lightning Design System.

Quick start

Before getting started ensure you have

Clone the project with git clone https://github.com/vlocityinc/newport-design-system.git
Change into the newport-design-system folder using cd newport-design-system.
Run npm install.
Run npm start to launch the Storybook.

Having trouble getting these steps to work on your machine? Follow the troubleshooting guide below.

Docs

For more indepth documentation please see the Wiki.

Tasks

Install gulp globally:

npm install --global gulp

`npm start`

Start the Lightning Design System preview app.

`gulp lint`

Lint the code base for syntax and stylistic errors.

# Lint indentation, Sass, JavaScript files
gulp lint

Compilation

`npm run build && npm run dist`

Generate the Lightning Design System into the .dist directory.

`gulp styles`

Compile Sass to CSS into .assets/styles.

`gulp clean`

Delete temporary build and local files.

Troubleshooting

npm and Node.js

The Vlocity Newport Design System uses npm to manage dependencies. Please install Node.js, and try running npm install again.

If Node.js is already installed, make sure you’re running v8 or up.

JavaScript and compilation issues

JavaScript dependencies sometimes get out of sync and inexplicable bugs start to happen. Follow these steps to give a fresh start to your development environment:

The installed npm version must be at least v3.10. You can update your npm with: npm install npm -g (sudo may be required).
Re-install dependencies: rm -Rf node_modules && npm install
npm start

If this did not work, try running npm cache clean and repeat the above steps.

Licenses

Source code is licensed under BSD 3-Clause
All icons and images are licensed under Creative Commons Attribution-NoDerivatives 4.0
The Lato font is licensed under the SIL OPEN FONT LICENSE

Got feedback?

Please open a new GitHub Issue.

leothelocust/newport-design-system