.
├── dist (created and managed by Gulp)
├── audio
├── fonts
├── img
├── node_modules (created and managed by NPM)
├── src
│ ├── scripts
│ └── styles
├── .jscsrc
├── .jshintrc
├── favicon.ico
├── gulpfile.js
│ ├── tasks
│ ├── utilities
│ ├── config.js
│ └── index.js
├── humans.txt
├── index.html
├── package.json
├── README.md
└── releasenotes.md
The /src
folder contains all JavaScript and Sass. Gulp will process these files using the configuration outlined in /gulpfile.js
, create the /dist
folder and save the proccessed files into the /dist
folder.
Browserify is used to manage and bundle JavaScript modules.
JSCS and JS Hint are used to highlights stylisitic and syntactical JS issues. Rules used are listed in .jscsrc
and .jshintrc
respectively.
Keep the humans.txt
updated and ensure the site has a favicon.ico
.
Note: Please view the README.md files within each folder for more info.
Run (in this directory):
npm install
This ensures the all the node packages are installed. Follow the NPM guide to install new packages.
Gulp is a task based build tool. It has been configured to run in two modes, development and production. Gulp will create, clean and manage the dist
folder.
Styles and scripts will be processed and watched for changes. Scripts will be linted.
Run (in this directory):
npm run gulp
Styles and scripts will be processed and minified. Modernizr will be custom built based on features used in the Sass and JavaScript.
Run (in this directory):
npm run gulp --production
##To do
- Remove unused code from Forecast.io JS API
- Add loading message for pre-js state