Skip to content

Ember.js implementation of the Upfluence Component Library & Design System.

License

Notifications You must be signed in to change notification settings

upfluence/oss-components

Repository files navigation

Upfluence OSS Components

This project hosts a bunch of branded (following the OSS framework) components for usage in our projects.

[Short description of the addon.]

Compatibility

  • Ember.js v3.24 or above
  • Ember CLI v3.24 or above
  • Node.js v12 or above

Installation

As any NPM package, you can install it via: npm install --save upfluence-oss-components

Running / Development

This addon's dummy app is actually a showcase of the frontend framework and its custom components.

It's an Ember app, so we assume you have all set up as that's our frontend stack anyway.

Adding it to a project

Here are the steps to add OSS-Components to an Ember project:

  • Install via npm install --save upfluence-oss-components
  • Install the Bower package containing all the needed CSS with bower install --save upfluence-oss
  • In your ember-cli-build.js file, add the following lines for enabling Asset Map file generation, and importing the Upfluence OSS framework:
// In the "fingerprint" configuration
fingerprint: {
  generateAssetMap: true,
  ...
}

// In the "lessOptions" configuration
lessOptions: {
  paths: [
    ...,
    'bower_components/upfluence-oss/less',
    ...
  ]
}
  • Enable the ember-cli-ifa, in the config/environment.js file
module.exports = function(environment) {
  var ENV = {
    ...,
    ifa: {
      enabled: true
    },
    ...
  };

  return ENV;
};
  • And finally, import the OSS framework in your app/styles/app.less file
@import 'bootstrap';
@import 'upfluence-oss';
@import 'upf-utils';
...