KathmanduLivingLabs/quake-tasks

Name: quake-tasks

Owner: Kathmandu Living Labs

Description: A quick Repo that shows some tasks for International developers to help with Nepal quake response.

Created: 2015-05-02 12:56:24.0

Updated: 2015-05-03 11:00:53.0

Pushed: 2015-05-03 11:00:52.0

Homepage: null

Size: 4849

Language: CSS

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

About

This is a codebase that will allow energy.gov users to quickly get started developing new graphics and maps. By cloning this repo, you can immidiately begin coding.

This app frame is built using the Foundation responsive framework. If you're looking for the original, pull down the App_Frame repository.

NOTE TO SELF, MUST DO MUCH UPDATING OF THIS README IN THE CONTENTS SECTION.

Dependencies

• Download and install Jekyll
• Foundation is already installed within this repository

Setup

• Clone the repo:

git clone https://github.com/energyapps/app-frame-foundation.git

• Rename the folder to your project name

mv app_frame/ new_directory_name/

• On the EnergyApps Github group create and name a new project repo, using “FND” in the title.
• cd into that folder in terminal and change remote URL to new repo:

git remote -v List all remote urls

git remote set-url origin https://github.com/energyapps/NEW-REPO-NAME.git -changes the remote url to your new URL

• Push to this new repo

git push -u origin master

• Branch out the gh-pages branch

git branch gh-pages git checkout gh-pages git push origin gh-pages

• Begin work in the index.html file.
• Build the Jekyll _site/ folder by running jekyll build in your directory. I recommend running jekyll build --watch, which automatically rebuilds your _site folder whenever you change something in the directory.
• Run the jekyll server by running jekyll serve. You can now see your page at
• Push changes to github, see website running remotely at energyapps.github.io/NEW-REPO-NAME/index.html
• Recommended: Update Readme to reflect your current project.

Contents

1. root directory
   • README.md
     • You are here.
   • index.html
     • Where you put your markup. The header info is for Jekyll. Leave it alone.
2. _layout/
   • The _layouts/ folder is the Jekyll folder that contains layouts for any type of page within a jekyll site.
   • default.html
     • This is a very rough cannibalization of the DOM elements in energy.gov/maps element.
     • Markup, CSS, and JS are merged here automatically by Jekyll, though you may need to update the links based on the js and css pages you create (below).
     • Contains links to JS, CSS in other folders (see below), as well as links to external energy.gov css files.
3. _site/
   • This is the folder that is generated by Jekyll and holds the merged static webpages.
4. js/
   • foundation.min.js
     • The Foundation javascript library.
   • data.js
     • Data for the map in json objects. This would be added to the maps content type.
   • script.js
     • script that executes all commands on graphic. This would be added to the maps content type.
5. css/
   • foundation/
     • contains the foundation.js CSS presets.
     • foundation_doe.css is the edited foundation document.
   • style.css
     • custom css to be added to map. CSS that would be added to the maps content type.
   • master_style.css
     • A static copy of the above as a fallback when the energy.gov links break.
   • fonts.css
     • a collection of some commonly used energy.gov fonts

Needs/Ideal Work flow

- You will create your content in markup.html, data.js, script.js, and style.css.
- These files will then be merged into the default.html using Jekyll pages.
- There are peculiarities to DOEs CSS that will affect how you program the markup. For instance the foundation "columns" class has been changed to "columnsDOE" in order to not interfere with existing cms.doe.gov "columns" CSS classes. PLEASE NOTE THAT THIS IS CURRENTLY UNDER DEVELOPMENT, AND THERE IS NO DOCUMENTATION COVERING THESE PECULIARITIES YET. THIS IS FORTHCOMING. BEWARE.

Notes

Public Domain

Updated: 2/23/15