@unabridged/midwest

Midwest Component Library

Midwest Component Library is an implementation of the Midwest Design System using ViewComponent.

This library is under active development. Breaking changes are likely until stable release.

Preview

https://midwest.design

Usage

Render Midwest ViewComponents:

= midwest_card(title: "Title") do
  %p Card example

Dependencies

• Stimulus

Installation

Add to Gemfile:

gem "midwest"

Run installer:

bin/rails midwest:install

Development

To get started:

1. Run: bundle install
2. Run: yarn install
3. Run: bin/dev

It will open demo app with component previews on localhost:4000. You can change components and they will be updated on page reload. Component previews located in demo/test/components/previews.

To run tests:

rake

To generate new components:

1. Run bin/rails midwest:generate:component YourComponent args

The syntax is similar to (ViewComponent's generator task)[https://viewcomponent.org/guide/generators.html].

Releases

The library follows semantic versioning. To draft a new release you need to run script/release with a new version number:

bin/release VERSION

Where the VERSION is the version number you want to release. This script will update the version in the gem and push it to GitHub and Rubygems automatically.

To release a new version of npm package update the package.json file with the new version number and run:

npm run release

After that make sure to commit changes in package.json.

License

The gem is available as open source under the terms of the MIT License.