Anatomy of a Component

demo/

A simple page used to display each topdoc pattern of the component. This view is useful for browser testing your component styles in isolation because it does not contain any external styles or scripts that could affect the testing of the component.

docs/

A style guide page documenting the rendered pattern, notes, example markup, and compiled CSS for each topdoc pattern of the component.

src/

The working folder containing component source files.

.bowerrc

Defines where Bower dependencies are initially installed. Note that bower install should not be run, use the grunt vendor task instead which uses the bower-install task to clean and move dependencies into src/vendor/.

.gitignore

What Git uses to determine which files and directories to ignore, before you make a commit.

CONTRIBUTING.md

Information related to contributing to the software.

COPYING.txt

The full software license.

Gruntfile.js

Used to configure or define tasks and load Grunt plugins that are used to compile and build the component files.

README.md

Contains helpful information relevant to the project. This is often the first place to look when getting acquainted with a new repository.

TERMS.md

Outlines the terms of use of the software.

bower.json

Used to record any front end packages that are necessary to build your component or project. Running grunt vendor in the same folder as the bower.json file will install the correct version of each dependency listed therein by way of the bower-install task.

package.json

Holds various metadata relevant to the component including which npm dependencies are required in order to compile and build it. Dependencies will mostly be Grunt tasks. Running npm install in the same folder as the package.json file will install the correct version of each dependency listed therein.