CASWOW

Demo

Prerequisites

This project requires the caswow.library to function correctly.

See the section on installing the caswow.library as part of the overall local development setup.

NPM to PNPM Transition

This project has transitioned to using PNPM as the package manager. The goal is to improve performance and efficiency in managing dependencies.

Install PNPM globally if you haven't already:

npm install -g pnpm

Import existing lockfiles from NPM, if they exist:

pnpm import

Install dependencies:

pnpm install

All subsequent commands that previously used npm should now use pnpm without declaring run. For example, to run the development server, instead of npm run dev use:

pnpm dev

Local Development

To run CAS WOW locally, simply clone the repository and install dependencies. Currently, this project requires Node v22, which can be set on a project basis by entering nvm use in the terminal.

1. git clone git@github.com:ComponentAssemblySystems/casWOW.git
2. pnpm install

caswow library

Run the following to link the caswow.library as a pnpm module:

$ cd /path/to/your/stylesheet
$ pnpm link

return to this project:

$ pnpm link ../caswow.library // path to your local caswow.library
$ pnpm install

Then copy the caswow CSS files into the dependencies folder:

$ pnpm copy-cas

or you can import it into site.css:

@import "caswow.library/css/caswow.css";

if the caswow.library is ever published, replace pnpm link caswow.library with pnpm install caswow.library to add it to the package.json dependencies.

Font Awesome

CASWOW uses Font Awesome for icons, with the current version set at v7.0.1.

Updates / Upgrades

To upgrade the version of Font Awesome, the following steps must be taken:

1. Update the version in package.json
2. Run pnpm install
3. Run copy-fa to copy the latest Font Awesome webfonts and CSS files to their respective CASWOW directories
4. Run pnpm build to rebuild the CASWOW project with the new dependencies
5. Verify the build has picked up the latest changes by checking the version under docs/css/fontawesome.css

You should now be able to run pnpm dev to view the icons with the newest version. If any icons are missing that are specific to the latest version, be sure to check dependencies/ and src/css/fontawesome.css to verify that the correct version has been copied over.

Notes

Architectural drawing found under /plans Photo by Amsterdam City Archives on Unsplash