lula-components

README

This package is a private LULA component library built with Vuejs 2.

WHAT IS THIS REPOSITORY FOR?

This package is for creating reusable vue components for the LULA dashboards.

• It leverages bootstrap-vue as a basis for building components that have a LULA-specific implementation.
• The goal is that we have one central place to modify components. The main benefits of this are
  1. This will allow us to avoid code duplication.
  2. but is will also keep our implementations for the same functionality consistent accross dashboards.

SET UP INSTRUCTIONS:

System requirements:

• Yarn package manager.
• Vue CLI.
• npm
• node version v14.19.3 or lower. (You can use nvm to switch between versions of node on your local machine).

First time setup:

yarn install sudo npm link lula-components

CONTRIBUTION GUIDELINES:

Using Git:

• Clone the lula-components from the LULA bitbucket repository (make sure your ssh key is set up first).
• Branch off the master branch using the following branch-name convention

component/{component-name}

• Create the component you wish to add to the package. (See components creation guidelines).
• Create a pull request to master, making sure to add the front-end team as reviewers.
• 2 approved reviews are required to add a component.

Component creation guidlines:

• Components must be prefixed by the word "Lula" to help identify them in our applications.

NEED HELP?

Simo Mafuxwana | [e-mail] Dylan Ranger | [e-mail]