README

BriteCore Design System

A VueJS-based component library for BriteCore user interfaces.

Contacts

Saad Siddiqui Engineer

Communication

Reach out to the maintainers on #pd-design-system-int

Additional Links

Documentation Website: https://ui.britecore.com
Summary Document: https://docs.google.com/document/d/1IE8-Gph3Smoh_avFbFA52gojoC-I6Cxqd_tFOHwI5SM (https://www.useloom.com/share/aec8ba7fe7ad43bf841082926ffdbf62)

Getting Started

Installation and Basic Usage

Note: BriteCore Design System is a private NPM module and requires a token to install. To get started, you'll need to add BriteCore-UI's .npmrc file to your project (https://github.com/IntuitiveWebSolutions/BriteCore-UI/blob/master/.npmrc).

Add the package to your project: yarn add @britecore/bc-design-system

Import BriteCore Design System in main.js:

import Vue from 'vue';
import BcComponents from '@britecore/bc-design-system';
import '@britecore/bc-design-system/lib/theme-chalk/index.css';
import App from './App.vue';

Vue.use(BcComponents);

new Vue({
  el: '#app',
  render: h => h(App)
});

Contributing

BriteCore Needs :point_right: YOU :point_left:

If you can't find what you're looking for, or you spot a bug, we strongly encourage you to submit a PR. The Design System is a resource for all of BriteCore and as such we're all invested in making it better. The Frontend Team is happy to help you with your pull request submission. We want to make sure it's an easy, quick, and painless process.

If you're ready to start contributing head over to the Contributing doc. If you get stuck, or have any questions feel free to reach out. See the contact information above.

Usage no npm install needed!