• Install Node.js 6.10.*. To check your installed version run node --version
• Update npm to the last version npm install -g npm@latest or ensure that you have installed at least the version 5.X. To check your installed version run npm --version

You should configure npm to make it pointing to the Apparound internal repository.

Go to TSF -> Connect to feed -> npm in order to generate the credentials and copy them into the .npmrc file placed in your user profile folder. (e.g. C:\Users\John\.npmrc for Windows users or ~/.npmrc for Linux/Mac OS X users)

Read this page for more informations.

• You can use the npm package published on the Apparound's internal repository
  • Run npm install --save apparound-design-lab@latest
• If you need to use your local framework repository, for example when you have to fix a bug on the framework
  • Run npm link <path of your local framework repository>/dist to link the package
  • Run npm unlink <path of your local framework repository>/dist to unlink the package
• Include the main.css file using ES6 import

import 'apparound-design-lab/css/main.css'

• Include what you need using scss (e.g. custom.scss)

@import
'~apparound-design-lab/scss/abstracts/variables',
'~apparound-design-lab/scss/abstracts/functions',
'~apparound-design-lab/scss/abstracts/mixins',
'~apparound-design-lab/scss/abstracts/placeholders';
// Custom styles for specific customisation
@import
'custom/salesTracker';

• Include your custom scss

import '<local path of your file>/<your file>.scss'

If you need to include the framework manually:

• Download the package and include all the folder in you project
• Inside the main HTML include all the js file that are inside the js folder and the "main.css"
• You can start using the framework with the component that you can find at this link http://atomdesignlab.apparound.it/, enjoy
• Bootstrap is the main framework for the structure and the components, please follow their guidelines http://getbootstrap.com/css/
• Plus Bootstrap Material Design is the theme, find here more information http://fezvrasta.github.io/bootstrap-material-design/
• If you have any questions and feedback, please write an email to design@apparound.com

Check the instructions contained in INSTRUCTIONS.md