Git Product home page Git Product logo

brewui's Introduction

BrewUI

User interface for the BrewCore project.

Goal

Having a common responsive controlling interface for the Brewfactory 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)
  • 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

brewui's People

Contributors

hekike avatar jketcham avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.