Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jgarber623/uswds-rails
A Ruby gem for integrating the U.S. Web Design System into a Ruby on Rails application.
https://github.com/jgarber623/uswds-rails
ruby rubygems rubyonrails uswds
Last synced: about 9 hours ago
JSON representation
A Ruby gem for integrating the U.S. Web Design System into a Ruby on Rails application.
- Host: GitHub
- URL: https://github.com/jgarber623/uswds-rails
- Owner: jgarber623
- License: other
- Archived: true
- Created: 2017-07-20T14:44:33.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-05-03T15:09:40.000Z (over 5 years ago)
- Last Synced: 2024-09-18T01:47:37.018Z (9 days ago)
- Topics: ruby, rubygems, rubyonrails, uswds
- Language: CSS
- Homepage: https://rubygems.org/gems/uswds-rails
- Size: 2.6 MB
- Stars: 4
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# uswds-rails
⚠️ **Deprecation Notice (2019-05-03)** ⚠️ This gem is deprecated and will no longer receive updates. Users are encouraged to use the latest version of [USWDS](https://github.com/uswds/uswds) and [rails/webpacker](https://www.github.com/rails/webpacker).
---
A Ruby gem for integrating the [U.S. Web Design System](https://github.com/uswds/uswds) into a [Ruby on Rails](http://rubyonrails.org) application.
[](https://rubygems.org/gems/uswds-rails)
[](https://rubygems.org/gems/uswds-rails)
[](https://travis-ci.org/jgarber623/uswds-rails)
[](https://depfu.com/github/jgarber623/uswds-rails)
[](https://codeclimate.com/github/jgarber623/uswds-rails)
[](https://codeclimate.com/github/jgarber623/uswds-rails/code)
## Getting Started
Before installing and using uswds-rails, you'll want to have Ruby 2.2.9 (or newer) installed on your computer. There are plenty of ways to go about this, but my preference is [rbenv](https://github.com/sstephenson/rbenv). If you're developing on a Mac and using [Homebrew](http://brew.sh), installing rbenv is [super easy](https://github.com/sstephenson/rbenv#homebrew-on-mac-os-x).
uswds-rails _might_ work with other versions of Ruby, but it's developed in 2.5.1 and automatically tested against 2.2.9, 2.3.8, 2.4.6, and 2.5.1 by [Travis CI](https://travis-ci.org/jgarber623/uswds-rails).
## Installation
Add uswds-rails to your Ruby on Rails project's Gemfile:
```rb
ruby '2.5.1'
source 'https://rubygems.org'
source 'https://rails-assets.org'
gem 'rails', '~> 5.1'
gem 'uswds-rails', '~> 1.4'
```
Run `bundle install` to install uswds-rails and its dependencies.
## Usage
uswds-rails makes available to your Rails application the fonts, images, JavaScript files, and stylesheets from the U.S. Web Design System. Including the files varies depending on type.
The most basic integration looks like:
```scss
// In `app/assets/stylesheets/application.scss`
@import "uswds/uswds";
```
```js
// In `app/assets/javascripts/application.js`
//= require "uswds/uswds";
```
Adding those lines to your project's `application.scss` and `application.js` will include _everything_ from the U.S. Web Design System (fonts, JavaScript, and stylesheets).
Don't want to include the entire stylesheet in your project? Not to worry! You may include individual SCSS files by using uswds-rails' [`app/assets/stylesheets/uswds/uswds.scss`](https://github.com/jgarber623/uswds-rails/blob/master/app/assets/stylesheets/uswds/uswds.scss) as a guide.
## Contributing
For details on setting up your development environment and contributing to this project, see [CONTRIBUTING.md](https://github.com/jgarber623/uswds-rails/blob/master/CONTRIBUTING.md).
## Acknowledgments
This project woudn't exist without the [18F](https://github.com/18F) team's hard work on the [U.S. Web Design System](https://github.com/uswds/uswds).
uswds-rails is written and maintained by [Jason Garber](https://github.com/jgarber623).
## License
uswds-rails is freely available under the [MIT License](https://opensource.org/licenses/MIT). Portions of the project contain code released under different licenses. See [LICENSE.md](https://github.com/jgarber623/uswds-rails/blob/master/LICENSE.md) for additional licensing information.