@springbuck/flesh/README.md

Concept UI for Springbuck Apps.

# Flesh

## Table of Content

* Introduction
* Installation
* Usage
* Licence

## Introduction

A UI concept for springbuck apps. consisting of styles, markups and behaviour.

## Installation

1. NPM
```
npm instal @springbuck/flesh --save

"dependencies": {
    ...
    "@springbuck/flesh": "~0.0.0",
    ...
}

```

2. Composer
```
$ composer require springbuck/flesh

"require": {
    ...
    "springbuck/flesh": "~0.0.0",
     ..
}

```
3. Manual
    - Download zip at https://github...
    - Extract
    - In
```
    <link></link>
    <script></script>
```

## Prerequisites

- This works on Windows, macOS and Linux.
- Node Package Manager and Gulp are required. Make sure you can run `gulp -v` and `npm -v`.
- You can get Node at [nodejs.org](https://nodejs.org), then install gulp using `npm install gulp-cli -g`

## Getting started

2. Clone this repo
3. Run `npm install`
4. Run `gulp watch`
4. Look at `index.html` (ideally with a [local development webserver](https://askubuntu.com/questions/377389/how-to-easily-start-a-webserver-in-any-folder))
5. Add any Bootstrap Sass variables into `scss/_custom-variables.scss`
6. Add any custom styles into `scss/_custom-styles.scss`. You can use Bootstrap's mixins here.
7. Repeat steps 4 to 6 until you like what you see :-)

## Thanks to:

**Alexander Rechsteiner**

- <https://hackerthemes.com>
- <https://twitter.com/arechsteiner>
- <https://github.com/arechsteiner>
- <https://hackerthemes.com/kit>

## Documentation
Visit [FLESH DOCS](src/docs) or http://

## Licence
Released under the MIT License, [LICENSE](LICENSE).