Mr.Watson | Nova (v0.1.0)

Front-end framework & style guide for www.mrwatson.com

Dependencies

• Node
• Bower

  $ npm install -g bower

• Yeoman

  $ npm install -g yo

• Sass

Installing

$ git clone https://github.com/mrwatson-oss/nova.git

$ npm install

$ bower install

Commands

$ grunt serve

$ grunt build

Create new components:

• Make sure grunt serve is running
• Open the project in your favorite editor and navigate to app/components
• Duplicate a component folder
• Change all file names (no special characters)
• Change component.js content names to new component name (cmd ^ F => oldComponentName = newComponentName)
• Add components Sass file to styles/main.scss
• Add component to ui-components.html and document it.
• $ grunt build
• $ git pull
• $ git add .
• $ git commit -m "your-commit-message"
• $ git push
• $ grunt gh-pages (Pushes /dist/ to gh-pages)

Add new bower packages

• Make sure grunt serve is running
• Depending on the package:

  $ bower install [package-name]

  $ bower install [package-name] --save

  $ bower install [package-name] --save-dev

  More info on bower commands here.

Grunt should automatically wiredep the right files to the index.html file.
If it doesn't, you can do it yourself via the $ grunt wiredep command.
If that doesn't work the package is not installed properly (check if it's there in the bower_components folder and the bower.json file.)

License

The MIT License (MIT).