Skip to content

Commit

Permalink
Initial structure
Browse files Browse the repository at this point in the history
  • Loading branch information
toastercup committed Jun 29, 2015
0 parents commit c53e412
Show file tree
Hide file tree
Showing 7 changed files with 102 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
node_modules/
bower_components/*/
.sass-cache/
.idea/

.env
.DS_Store
.ruby-gemset
.ruby-version

log/*.log
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# employer-style-grid

A stack-agnostic SASS library providing a framework-agnostic, [Neat](http://neat.bourbon.io/)-based grid system intended for the Employer experience.

### Consumption

Install with Bower (from an appropriate repository)

```sh
$ bower install employer-style-grid
```

Now, import `sass/grid` after [Neat](http://neat.bourbon.io/) Helpers, and after a framework like [Bourbon](http://bourbon.io/) in your main `application.scss`. Then, import Neat. For example:

```scss
@import 'bower_components/bourbon/app/assets/stylesheets/bourbon';
@import 'bower_components/neat/app/assets/stylesheets/neat-helpers';
@import 'bower_components/employer-style-grid/sass/grid';
@import 'bower_components/neat/app/assets/stylesheets/neat';

@import 'your-app';
```

You can now use [Neat mixins](http://thoughtbot.github.io/neat-docs/latest/) and the provided breakpoints (see `_grid-settings.scss`).

### What's included

At the moment, only uncompiled SASS source files are available for consumption. That means your application will need to perform the precompilation, whether it be through Gulp, Grunt, Rails asset pipeline, etc. Do note that `employer-style-grid` simply wraps around, and depends upon [Neat](http://neat.bourbon.io/) to actually power its grid system.

### Future

- Implement build process to compile CSS into `dist` for easy consumption
34 changes: 34 additions & 0 deletions bower.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"name": "employer-style-grid",
"version": "0.0.1",
"authors": [
"Content Enablement <[email protected]>"
],
"description": "A stack-agnostic SASS library providing a framework-agnostic, Neat-based grid system intended for the Employer experience",
"keywords": [
"cb",
"careerbuilder",
"employer",
"platform",
"style",
"styling",
"grid",
"sass",
"css"
],
"private": true,
"main": [
"sass/_grid.scss",
"sass/_grid-settings.scss"
],
"ignore": [
"**/.*",
"node_modules",
"bower_components",
"test",
"tests"
],
"dependencies": {
"neat": "~1.7.2"
}
}
Empty file added dist/.keep
Empty file.
15 changes: 15 additions & 0 deletions sass/_grid-settings.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// Widths
$mobile-width: em(480);
$small-tablet-width: em(720);
$large-tablet-width: em(960);
$desktop-width: em(1050);

// Breakpoints
$mobile: new-breakpoint(max-width $mobile-width, 4);
$small-tablet: new-breakpoint(min-width $small-tablet-width max-width $large-tablet-width - 1, 8);
$large-tablet: new-breakpoint(min-width $large-tablet-width max-width $desktop-width - 1, 12);
$tablet: new-breakpoint(min-width $small-tablet-width max-width $desktop-width - 1, 12);
$desktop: new-breakpoint(min-width $desktop-width, 16);

$small-tablet-down: new-breakpoint(max-width $large-tablet-width, 8);
$tablet-down: new-breakpoint(max-width $desktop, 8);
1 change: 1 addition & 0 deletions sass/_grid.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@import '_grid-settings';

0 comments on commit c53e412

Please sign in to comment.