Code Monkey home page Code Monkey logo

musical-weathervane's Introduction

Musical Weathervane

Structure

.
├── 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.

Installation

Run (in this directory):

npm install

This ensures the all the node packages are installed. Follow the NPM guide to install new packages.

Build

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.

Development

Styles and scripts will be processed and watched for changes. Scripts will be linted.

Run (in this directory):

npm run gulp

Production

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

References

##To do

  • Remove unused code from Forecast.io JS API
  • Add loading message for pre-js state

musical-weathervane's People

Contributors

rjbultitude avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.