<!--
@page spectre Home
@group spectre.components Components
@group spectre.util Utilities
-->


# spectre-canjs

[![Build Status](https://travis-ci.org/roemhildtg/spectre-canjs.svg?branch=master)](https://travis-ci.org/roemhildtg/spectre-canjs)
[![NPM](https://nodei.co/npm/spectre-canjs.png?compact=true)](https://npmjs.org/package/spectre-canjs)

A collection of data administration and management components to enable
the rapid developement of client side web applications. Built on the Spectre CSS
framework crossed with CanJS to provide fast, beautiful, navigation,
data management, and user interface web components.

## Documentation

You can access the projects documentation at the [Github Pages URL](https://roemhildtg.github.io/spectre-canjs/docs/index.html)

## Quick Start

```
git clone <this-repository>
cd <this-folder>
npm install

# optional: start a web server to run the demos
npm install -g http-server
http-server
```

Now open a web browser and browse each folder's `demo.html`.

## Docs

```
npm run docs
```

Now open a web browser in the `./docs/` folder

## Tests

Running the tests is as easy as:

```
npm run test
```

## Contributing

Issues may be opened for feature requests, problem, and suggestions. Pull requests
with explanations may be considered.
