Skip to content
This repository has been archived by the owner on Feb 23, 2024. It is now read-only.

code-312/design-system

Repository files navigation

Code for Chicago Design System

It is a design system.

Getting Started

  1. To run locally, you will need gem and Ruby's bundle installed.
  2. Run bundle to install dependencies.
  3. Run bundle exec jekyll serve. This will build the static site and watch for changes.
  4. Visit http://localhost:4000 in your browser to see the style guide.

Prerequisites

Ruby

It is advisable to avoid using the OS install of Ruby that comes bundled with MacOS, Ubuntu, and others. Instead we'd suggest using a Ruby virtual environment like rbenv. Installation instructions can be found here.

To verify your ruby version:

> ruby -v
ruby 2.7.0p0 (2019-12-25 revision 647ee6f091) [x86_64-darwin18]

We are using ruby 2.7.0 for this project.

Bundler

To install bundler, use:

> gem install bundler

Find us on our slack #general channel if we can be of assistance getting you set up.

All contributions are very welcome. Thank you!