Initial commit for basic front end architecture and standard repo needs.

jkfjlkfds

Author: Julia Elman

.gitignore

@@ -0,0 +1,10 @@
+# Logs
+logs
+*.log
+
+# Dependency directories
+node_modules/
+bower_components/
+
+# Mac specific
+.DS_Store

CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# Contributor Guidelines
+
+Want to contribute? Here are a few guidelines to following:
+
+1. Create a branch that lightly defines what you are working on (e.g. adding-styles).
+2. Once you are ready to submit a pull request, push your branch up to the repo.
+3. Submit your pull request against `master` branch.

LICENSE.md

@@ -0,0 +1,31 @@
+As a work of the United States Government, this project is in the
+public domain within the United States.
+
+Additionally, we waive copyright and related rights in the work
+worldwide through the CC0 1.0 Universal public domain dedication.
+
+## CC0 1.0 Universal Summary
+
+This is a human-readable summary of the [Legal Code (read the full text)](https://creativecommons.org/publicdomain/zero/1.0/legalcode).
+
+### No Copyright
+
+The person who associated a work with this deed has dedicated the work to
+the public domain by waiving all of his or her rights to the work worldwide
+under copyright law, including all related and neighboring rights, to the
+extent allowed by law.
+
+You can copy, modify, distribute and perform the work, even for commercial
+purposes, all without asking permission.
+
+### Other Information
+
+In no way are the patent or trademark rights of any person affected by CC0,
+nor are the rights that other persons may have in the work or in how the
+work is used, such as publicity or privacy rights.
+
+Unless expressly stated otherwise, the person who associated a work with
+this deed makes no warranties about the work, and disclaims liability for
+all uses of the work, to the fullest extent permitted by applicable law.
+When using or citing the work, you should not imply endorsement by the
+author or the affirmer.

README.md

@@ -1,2 +1,41 @@
 # dotgov-dashboard
 A dashboard of useful information about .gov domains.  
+
+## Prerequisites
+
+1. [node/npm](https://nodejs.org/download/)
+2. [bower](http://bower.io/#install-bower)
+3. [Chrome LiveReload extension](https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei?hl=en)
+
+## Installation
+
+1) Clone the repo to your desktop.
+
+```bash
+$ git clone git@github.com:18F/dotgov-dashboard.git
+```
+
+2) Run the following commands to install the necessary packages:
+
+```bash
+$ npm install
+$ bower install
+```
+
+3) Now you should be able to run `gulp` and open the `index.html` file in your favorite browser.
+
+```bash
+$ gulp
+```
+
+4) You'll now have your `.scss` files auto compile to `main.min.css` using a watch command. LiveReload is also a part of the process, but you'll need to make sure to have the [Chrome LiveReload extension](https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei?hl=en) installed in whatever version of Chrome you are using.
+
+## Public domain
+
+This project is in the public domain within the United States, and
+copyright and related rights in the work worldwide are waived through
+the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).
+
+All contributions to this project will be released under the CC0
+dedication. By submitting a pull request, you are agreeing to comply
+with this waiver of copyright interest.

bower.json

@@ -0,0 +1,18 @@
+{
+  "name": "dotgov-dashboard",
+  "version": "0.0.1",
+  "homepage": "https://github.com/18F/dotgov-dashboard",
+  "authors": [],
+  "license": "CC0 1.0 Universal Summary",
+  "ignore": [
+    "**/.*",
+    "node_modules",
+    "bower_components",
+    "test",
+    "tests"
+  ],
+  "devDependencies": {
+    "bourbon": "~4.2.2",
+    "neat": "~1.7.2"
+  }
+}

css/main.min.css

@@ -0,0 +1,24 @@
+var gulp        = require('gulp'),
+    sass        = require('gulp-sass'),
+    watch       = require('gulp-watch'),
+    minifycss   = require('gulp-minify-css'),
+    rename      = require('gulp-rename'),
+    livereload  = require('gulp-livereload');
+
+gulp.task('sass', function() {
+    return gulp.src('scss/main.scss')
+        .pipe(sass())
+        .pipe(minifycss())
+        .pipe(rename({suffix: '.min'}))
+        .pipe(gulp.dest('css'))
+        .pipe(livereload());
+});
+
+gulp.task('watch', function() {
+    livereload.listen();
+    gulp.watch('scss/**/*', ['sass']);
+    gulp.watch('index.html')
+    	.on('change', livereload.changed);
+});
+
+gulp.task('default', ['sass', 'watch']);