BU Base

Standardized set of SCSS utilities and CSS variables for use across plugins and themes.

Installation

Install the package

npm i @bostonuniversity/base

Use

SCSS utilities and variables In your theme or plugin's SCSS file, include styles like so:

@use '~@bostonuniversity/base/styles/abstracts/mixins/breakpoints' as bp;

Publishing & Release Process

This package is managed through NPM (https://www.npmjs.com/). It can be found here: https://www.npmjs.com/package/@bostonuniversity/base

Publishing Process:

• increment the version number and merge your branch in once approved
• create a new release in github using the new version number
• the github action will run and publish to NPM automatically

Dev & Testing

Vite has been installed in order to quickly test scss and js compiling for bu-base. The output is in the dist folder and not currently used in production or commited to git.

To run compiling open a project terminal and run npm run vite:watch and this will start a watcher that updates on every save.

In order to also watch and update yalc, in a separate project terminal run npm run yalc:watch.