# make-shift-brew-ui

> Common User Interface for the Brewfactory projects, modified for MakeShift Aleworks

Latest version **1.5.4** (published 2016-08-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install make-shift-brew-ui
pnpm add make-shift-brew-ui
yarn add make-shift-brew-ui
bun add make-shift-brew-ui
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.4 |
| Published | 2016-08-27 |
| First published | 2016-08-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 38 |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | yes |
| Maintainers | makeshift_aleworks |
| Keywords | Homebrew, React, Flux |

## Links

- npm: https://www.npmjs.com/package/make-shift-brew-ui
- Repository: https://github.com/JesseKoester/MakeShiftBrewUI
- Homepage: https://github.com/JesseKoester/MakeShiftBrewUI#readme
- Issues: https://github.com/JesseKoester/MakeShiftBrewUI/issues
- npm.io page: https://npm.io/package/make-shift-brew-ui

## Dependencies (38)

- [gulp](https://npm.io/package/gulp.md) ^3.8.8
- [async](https://npm.io/package/async.md) ^0.9.0
- [bower](https://npm.io/package/bower.md) ^1.6.5
- [debug](https://npm.io/package/debug.md) ^2.0.0
- [react](https://npm.io/package/react.md) ^0.12.0
- [routr](https://npm.io/package/routr.md) ^0.0.4
- [jshint](https://npm.io/package/jshint.md) ^2.5.0
- [moment](https://npm.io/package/moment.md) ^2.8.3
- [webpack](https://npm.io/package/webpack.md) ^1.4.13
- [bluebird](https://npm.io/package/bluebird.md) ^2.3.10
- [paths-js](https://npm.io/package/paths-js.md) ^0.3.0
- [dispatchr](https://npm.io/package/dispatchr.md) ^0.2.7
- [gulp-csso](https://npm.io/package/gulp-csso.md) ^0.2.9
- [gulp-size](https://npm.io/package/gulp-size.md) ~1.1.0
- [gulp-util](https://npm.io/package/gulp-util.md) ~3.0.1
- [gulp-bower](https://npm.io/package/gulp-bower.md) 0.0.7
- [gulp-clean](https://npm.io/package/gulp-clean.md) ~0.3.1
- [gulp-react](https://npm.io/package/gulp-react.md) ~2.0.0
- [jsx-loader](https://npm.io/package/jsx-loader.md) ^0.12.0
- [rising-url](https://npm.io/package/rising-url.md) ^1.0.3
- [superagent](https://npm.io/package/superagent.md) ^0.20.0
- [url-loader](https://npm.io/package/url-loader.md) ^0.5.5
- [file-loader](https://npm.io/package/file-loader.md) *
- [gulp-filter](https://npm.io/package/gulp-filter.md) ^1.0.2
- [gulp-uglify](https://npm.io/package/gulp-uglify.md) ^1.0.1
- [gulp-usemin](https://npm.io/package/gulp-usemin.md) ^0.3.8
- [lodash-node](https://npm.io/package/lodash-node.md) ^2.4.1
- [gulp-connect](https://npm.io/package/gulp-connect.md) ^2.0.6
- [gulp-flatten](https://npm.io/package/gulp-flatten.md) 0.0.4
- [run-sequence](https://npm.io/package/run-sequence.md) ^1.0.1
- [jshint-loader](https://npm.io/package/jshint-loader.md) ^0.8.0
- [gulp-livereload](https://npm.io/package/gulp-livereload.md) ^2.1.1
- [gulp-json-editor](https://npm.io/package/gulp-json-editor.md) ^2.1.1
- [main-bower-files](https://npm.io/package/main-bower-files.md) ^2.0.0
- [socket.io-client](https://npm.io/package/socket.io-client.md) ^1.2.0
- [gulp-load-plugins](https://npm.io/package/gulp-load-plugins.md) ~0.7.0
- [connect-modrewrite](https://npm.io/package/connect-modrewrite.md) ^0.7.9
- [flux-router-component](https://npm.io/package/flux-router-component.md) ^0.4.3

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.5.4 (latest) — 2016-08-27
- 1.5.3 — 2016-08-26
- 1.5.2 — 2016-08-23
- 1.5.1 — 2016-08-22

## README

# BrewUI

User interface for the [BrewCore](https://github.com/brewfactory/BrewCore) project.

## Goal
Having a common responsive controlling interface for the [Brewfactory](http://brewfactory.org)
projects.

### Features
* Schedules new brew
* Monitors brewing
* Visualises brew logs

## How to use

### Interfaces

### Public interfaces
`var BrewUI = require('brew-ui');`

* `BrewUI.routes` -> returns route config (good to check SPA routes)
* `BrewUI.build(outputPath)` -> see below
* `BrewUI.isomorphic()` -> add `BrewUI.App`, `BrewUI.React`, `BrewUI.actions` endpoints (needs [JSX support](https://www.npmjs.org/package/node-jsx))
* `getStaticPath()` -> returns with the static path to the dist directory

#### Overwrite API host
Default: `/`

* Without WebSockets support (will use pooling)
`API=http://localhost:8080 gulp serve` or  

* With WebSockets support
`localStorage.API_HOST= 'http://localhost:8080'` or  
 `window.API_HOST= 'http://localhost:8080'`


### Use as pre-built

Install package  
`npm install brew-ui`  

`var BrewUI = require('brew-ui');`
Serve `BrewUI.getStaticPath()` as  static folder.

**Express example:**
```
var BrewUI = require('brew-ui');
app.use(express.static(BrewUI.getStaticPath()));
```

### Build from project

Install dev dependencies too:
`cd node_modules/brew-ui; npm install`

Build:
```
var BrewUI = require('brew-ui');
var distPath = '/my-projects/brewer/public'

// Build only when it's necessary
BrewUI.build(distPath)
	.then(function (wasBuild) {
	  console.log('Was it built: ' + wasBuild);
	})
	.catch(function (err) {
	  console.error(err);
	});
```

## How to run

**Build dist**
`gulp`

**Serve / watch**
`gulp serve`  

Overwrite API host:
`API=http://localhost:8080 gulp serve`

## Technologies

* React
* Flux
* Isomorphic
* Twitter Bootstrap

---
_Source: https://npm.io/package/make-shift-brew-ui · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
