Skip to content

Commit

Permalink
First commit! 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
dreamingechoes committed Feb 18, 2018
0 parents commit c5def68
Show file tree
Hide file tree
Showing 44 changed files with 52,623 additions and 0 deletions.
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<!---
Provide a general summary of the issue here.
-->

## Expected behavior

<!---
If you're describing a bug, tell what should happen.
If you're suggesting a feature/change/improvement, tell how it should work.
[Please remove this section if you don't provide any information]
-->

## Current behavior

<!---
If describing a bug, tell what happens instead of the expected behavior.
If suggesting a feature/change/improvement, explain the difference from current behavior.
[Please remove this section if you don't provide any information]
-->

## Possible solution

<!---
Not obligatory, but suggest a fix/reason for the bug,
or ideas how to implement the addition or change.
[Please remove this section if you don't provide any information]
-->

## Steps to reproduce (for bugs)

<!---
Provide a link to a live example, or an unambiguous set of steps to
reproduce this bug. Include code to reproduce, if relevant.
[Please remove this section if you don't provide any information]
-->

## Context

<!---
How has this issue affected you? What are you trying to accomplish?
Providing context helps to come up with a solution that is most useful in the real world.
[Please remove this section if you don't provide any information]
-->

## Your environment

<!---
Include as many relevant details about the environment you experienced the bug in.
[Please remove this section if you don't provide any information]
-->

* Browser Name and version:
* Operating System and version (desktop or mobile):
* Link:

## Screenshots (if appropriate)

<!---
Include as many relevant screenshots as you can.
[Please remove this section if you don't provide any information]
-->
34 changes: 34 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Connects to #N.

## What does this PR do?

## Where should the reviewer start?

## How should this be manually tested?

## Any background context you want to provide?

## What are the relevant issues?

## Screenshots (if appropriate)

## Types of changes

- [ ] Bug fix (non-breaking change which fixes an issue).
- [ ] New feature (non-breaking change which adds functionality).
- [ ] Breaking change (fix or feature that would cause existing functionality to change).

## Checklist

- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.

## Questions

- [ ] Does the knowledge base (guidelines) need an update?
- [ ] Does this add new dependencies which need to be added to the development environment?
- [ ] Does this add new dependencies which need to be added to the production environment?
- [ ] Is there a blog post?
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/.bundle/
/.yardoc
/Gemfile.lock
/_yardoc/
/coverage/
/doc/
/pkg/
/spec/reports/
/tmp/
4 changes: 4 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
language: ruby
rvm:
- 2.5.0
before_install: gem install bundler -v 1.16.1
73 changes: 73 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org
4 changes: 4 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
source 'https://rubygems.org'

# Specify your gem's dependencies in bootstrap_sb_admin_base_v1.gemspec
gemspec
21 changes: 21 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2018 Ivan Gonzalez

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
57 changes: 57 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
[![Gem Version](https://badge.fury.io/rb/bootstrap_sb_admin_base_v1.svg)](https://badge.fury.io/rb/bootstrap_sb_admin_base_v1)

## About

bootstrap_sb_admin_base_v1 is a Rails gem of the Bootstrap based admin theme SB Admin 1. Originally created by Start Bootstrap, all the credits of the development of the Bootstrap admin theme are of them. This is just and adaptation into Rails gem in order to make it easier to integrate all the assets (fonts, images, css and js) into a Rails application.

You can check the original Bootstrap admin theme repository [here](https://github.com/BlackrockDigital/startbootstrap-sb-admin).

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'bootstrap_sb_admin_base_v1'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install bootstrap_sb_admin_base_v1

## Usage

This gem has two dependencies: `jquery-rails` and `font-awesome-rails` in order to keep updated the versions of **jQuery** and **font-awesome**, so be sure to require `jquery-rails` on your `application.js` before require the `bootstrap_sb_admin_base_v1` file like so:

```ruby
//= require jquery
//= require bootstrap_sb_admin_base_v1
//= require turbolinks
//= require_tree .
```

and on the `application.css` file, be sure to require the `font-awesome-rails` file:

```ruby
*= require font-awesome
*= require bootstrap_sb_admin_base_v1
```

And you're ready to use the HTML structure of the Bootstrap based admin theme SB Admin on your Rails application. All the details and documentation about this are [here](http://startbootstrap.com/template-overviews/sb-admin/).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/dreamingechoes/bootstrap_sb_admin_base_v1. 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.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

----------------------------

This project was developed by [dreamingechoes](https://github.com/dreamingechoes).
It adheres to its [code of conduct](https://github.com/dreamingechoes/base/blob/master/files/CODE_OF_CONDUCT.md) and
[contributing guidelines](https://github.com/dreamingechoes/base/blob/master/files/CONTRIBUTING.md), and uses an equivalent [license](https://github.com/dreamingechoes/base/blob/master/files/LICENSE).
1 change: 1 addition & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
require "bundler/gem_tasks"
14 changes: 14 additions & 0 deletions bin/console
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#!/usr/bin/env ruby

require "bundler/setup"
require "bootstrap_sb_admin_base_v1"

# You can add fixtures and/or initialization code here to make experimenting
# with your gem easier. You can also use a different console, if you like.

# (If you use this, don't forget to add pry to your Gemfile!)
# require "pry"
# Pry.start

require "irb"
IRB.start
7 changes: 7 additions & 0 deletions bin/setup
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/bin/bash
set -euo pipefail
IFS=$'\n\t'

bundle install

# Do any other automated setup that you need to do here
Binary file added bootstrap_sb_admin_base_v1-0.1.0.gem
Binary file not shown.
24 changes: 24 additions & 0 deletions bootstrap_sb_admin_base_v1.gemspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# coding: utf-8
lib = File.expand_path('../lib', __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require 'bootstrap_sb_admin_base_v1/version'

Gem::Specification.new do |spec|
spec.name = "bootstrap_sb_admin_base_v1"
spec.version = BootstrapSbAdminBaseV1::VERSION
spec.authors = ["Ivan Gonzalez"]
spec.email = ["[email protected]"]

spec.summary = "Rails gem of the Bootstrap based admin theme SB Admin"
spec.description = "Rails gem of the Bootstrap based admin theme SB Admin. Originally created by Start Bootstrap. You could check the original theme on https://github.com/BlackrockDigital/startbootstrap-sb-admin"
spec.homepage = "https://github.com/dreamingechoes/bootstrap_sb_admin_base_v1"
spec.license = "MIT"

spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
spec.bindir = "exe"
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
spec.require_paths = ["lib"]

spec.add_runtime_dependency "jquery-rails"
spec.add_runtime_dependency "font-awesome-rails"
end
10 changes: 10 additions & 0 deletions lib/bootstrap_sb_admin_base_v1.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
require "bootstrap_sb_admin_base_v1/version"

module BootstrapSbAdminBaseV1
module Rails
class Engine < ::Rails::Engine
require "jquery-rails"
require "font-awesome-rails"
end
end
end
3 changes: 3 additions & 0 deletions lib/bootstrap_sb_admin_base_v1/version.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module BootstrapSbAdminBaseV1
VERSION = "0.1.0"
end
Binary file not shown.
Loading

0 comments on commit c5def68

Please sign in to comment.