Sha256: a971e370021a1e53434b753cf6e69c4c8dd6cbcbf515a88de534c6e338cbbfa5

Contents?: true

Size: 1.72 KB

Versions: 5

Compression:

Stored size: 1.72 KB

Contents

# VaCommon

This includes generation of header and footer, as well as the assets for vets.gov, such as javascript, scss, images, fonts.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'va_common'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install va_common

## Usage

For the stylesheets, include this in the application.css file

    *= require va_common_main

For the js, include this in the application.js file

    //= require va_common_main

To generate the header, run 

    $ rails generate va_header

To generate the footer, run 

    $ rails generate va_footer

To generate both, run

    $ rails generate va_common

Your primary view should look something like this:

    <div class="container">
      <%= render 'common/header' %>
      <main role="main">
        <%= yield %>
        <%= render 'common/footer' %>
      </main>
    </div>

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/va_common. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.

Version data entries

5 entries across 5 versions & 1 rubygems

Version Path
va_common-0.2.4 README.md
va_common-0.2.3 README.md
va_common-0.2.2 README.md
va_common-0.2.1 README.md
va_common-0.2.0 README.md