@ritterim/platform-ui

Platform UI

Platform UI is a CSS framework, rooted in Sass, used by Ritter Insurance Marketing (RIM) for our platform of agent tools. It's being built as a replacement for existing frameworks while considering some of our unique needs.

As we continue to improve Platform UI, we hope to create an easy to use framework that other developers can implement.

Publishing

Platform UI is published privately on a regular basis to MyGet and GitHub Packages. Builds are also published to npm as @ritterim/platform-ui.

The patch version value will be bumped on every merge to the trunk branch.

Styleguide

Documentation for Platform UI is generated on every build using KSS-Node and hosted here.

Roadmap

• [ ] Documentation (always) 📓
• [x] Styleguide redesign v0.9 😃
• [ ] Search UI v1.0 🔎

Scripts

• start - Optimizes icons and generates icon font, then starts the Vite development server
• build - Builds the package, runs all scripts prefixed with "build"
• build:svgs - Optimizes all icon SVGs with SVGO
• build:font - Creates the icon font based off the optimized SVGs
• start:vite - Starts the Vite development server
• build:vite - Optimizes everything and bundles as package