RFC - change raw components to built/minified (web components)

severinbeauvais commented 2 years ago

The BCRS Shared Components project contains many components that are used by several UI projects (Filings UI, FAS, etc). The problem is that these shared components are raw source code, and as such:

have dependencies (eg, CSS, mixins, interfaces)
require specific framework versions (eg, Vue)
require the host project to also be Vue framework (with same dependencies and versions, etc)
require maintenance due to new versions of dependencies

There is a better way. In a nutshell, it means going a bit further with the BCRS Shared Components project and Lerna (which manages individual component versioning), to build production-ready components that are standalone and can be imported into any host project, any time.

This change should start as a RFC / prototype (same as we did for original BCRS Shared Components) to figure out exactly how to do this. The next step depends on the changes needed. It might require updating all host projects to use new shared components; this would all come out in the RFC, including a possible phased approach. The RFC could also estimate effort.

@shabeeb-aot (Faiz) created a similar ticket in the Relationships team space. Faiz knows a bit about this already and would therefore be a key resource in designing/ implementing this. I don't know how we would allocate the work as this change crosses over several teams and will benefit all.

I have added the Tech Debt label, which isn't totally correct since this is not incomplete development. Rather, it's a much-improved way to build and serve shared components that will make their use much easier to manage/maintain as time goes by.

Web Components

ref: https://vuejs.org/guide/extras/web-components.html

severinbeauvais commented 2 years ago

bcgov / entity

RFC - change raw components to built/minified (web components) #10725

Web Components