bootstrap_bux 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 645d1a1a9453763a7bdfccc7eaa7565098a66db02fc88b53bb019aa8064c0118
+  data.tar.gz: 4038d58383928c882c42b3abbfe9dc8ffde522675c2bbc002995f0b4bbddd02e
+SHA512:
+  metadata.gz: fa48e55bc19ddebb94f404f76f0491385c3997573e5761e8413d21b94ab505d860fe42577592934218282049da23c02b4cb22b36a9b7210bed08f2ceb664ce92
+  data.tar.gz: 22cfd467fa4846a9319c9cf5dbc89bac8bff71ffcd7386dcc23f515137c974bd09b4ec09b37e952923034ef50cac2d9ab69563c92f04c991e63104ba59c1b5a0

data/README.md

@@ -0,0 +1,78 @@
+# BootstrapBux
+
+Bootstrap Bux is a Rails-y way of including the mandatory OSU headers and footers to any website, using the basic BUX color scheme and fonts, while still allowing you to use the Bootstrap (5.3+) framework.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add bootstrap_bux
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install bootstrap_bux
+
+## Usage
+
+Once the gem is installed, place a configuration file at `config/initializers/bootstrap_bux.rb` with the following contents:
+
+    BootstrapBux.configure do |config|
+      # update these configuration options with your actual departmental info
+      config.department_name = "My Office"
+      config.building_room = "100 Building Name"
+      config.address = "1 Oval Mall"
+      config.email = "email@osu.edu"
+      config.phone = "614-292-OHIO"
+      config.fax = "614-555-5555"
+
+      # only add urls for these if your application/lab/department actually has a presence on the platform
+      config.facebook = nil
+      config.twitter = nil
+      config.instagram = nil
+      config.linkedin = nil
+      config.youtube = nil
+      config.tiktok = nil
+    end
+
+
+Editing the options in this file will allow you to change the contents of the footer to reflect actual departmental info. Note that if you do not enter URLs for the social media sites those items will be omitted from the footer, but you must include values for all other contact attributes.
+
+Within your Rails application, rendering headers and footers is simple.
+
+In your CSS/SCSS file:
+
+    @import "bootstrap_bux/application";
+
+In your view (most likely in the application layout):
+
+    = render 'bootstrap_bux/osu_header'
+
+and
+
+    = render 'bootstrap_bux/osu_header_dark'
+
+or
+
+    = render 'bootstrap_bux/osu_header_light'
+
+or
+
+    = render 'bootstrap_bux/osu_header_white'
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://code.osu.edu/asctech/bootstrap_bux_gem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://code.osu.edu/asctech/bootstrap_bux_gem/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the BootstrapBux project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://code.osu.edu/asctech/bootstrap_bux_gem/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]