dodekeract/smartflat-core

# Smartflat Core

[![Join the chat at https://gitter.im/dodekeract/smartflat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dodekeract/smartflat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT)
[![Build Status](https://api.travis-ci.org/dodekeract/smartflat-core.svg)](https://travis-ci.org/dodekeract/smartflat-core/)
[![Code Climate](https://codeclimate.com/github/dodekeract/smartflat-core/badges/gpa.svg)](https://codeclimate.com/github/dodekeract/smartflat-core)
[![Coverage Status](https://coveralls.io/repos/github/dodekeract/smartflat-core/badge.svg?branch=master)](https://coveralls.io/github/dodekeract/smartflat-core?branch=master)
[![NPM Downloads](https://img.shields.io/npm/dt/smartflat-core.svg)](https://npmjs.com/package/smartflat-core)
[![NPM Dependencies](https://david-dm.org/dodekeract/smartflat-core.svg)](https://david-dm.org/dodekeract/smartflat-core)

The mainframe of smartflat. Loads and connects other smartflat modules.

## Installation

Since this module is used to run smartflat, it should be installed globally. If installed correctly, you should be able to just run `smartflat` to start it.

### Via `npm`

- `npm install -g smartflat-core`

### Via `git`

- `git clone https://github.com/dodekeract/smartflat-core`
- `npm install`
- `npm link`
- `npm run build`

## FAQ

### Why is `build` published on GitHub? Isn't that redundant?

It's needed for viewing the covered lines in coveralls, so I included it.