Skip to content

kmadej/motech-ui

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

The MOTECH-UI is an administration user interface to be used with the MOTECH Platform. Currently this UI package is underdevelopment, so it won't support all the functionality needed to administer the MOTECH Platform.

Overview

This UI package creates a single page AngularJS applicaiton that interacts with the REST API exposed by the MOTECH Server. Styles and components available in the UI are documented in the MOTECH-UI Styleguide, which is generated from this package.

NodeJS and Gulp are used to generate the MOTECH-UI. NPM and Bower are the package managers used in the project. Sass & Bourbon

This application follows John Papa structure guidelines as closely as possible.

Goals

Semantic Mark-up

Less markup on HTML elements makes it easier for the styles to be changed in one place. An example of this is that all images that are not primary content should be implemented in CSS.

Graceful Degredation

We support IE9 and up, meaning our interface must function in all browsers possible — but all experiences don't need to be exactly the same, just equally functional.

Optimized for small screens and touchpads

MOTECH is used by people to configure health workflows. Many of these people use laptops and don't have access to a mouse.

Installation

To use this UI package a working MOTECH Server is required. It is possible to run and work on this package without a MOTECH Server, but only the styleguide will fully work.

Linux Installation

Stub

Windows Installation

Stub

OSX Installation

Stub

Building and running

To build and run the MOTECH-UI package:

gulp build
gulp server

Then visit http://localhost:5000/styleguide/ and you should see this page (assuming nothing went wrong).

Gulp Commands

Build

Builds the main index.html and asset files for the MOTECH-UI, and places them in the /build directory.

The directory where files are built can be changed by passing the --dest option.

gulp build --dest=./build
// Build only the app
gulp build:app
// Build only the style guide
gulp build:styleguide

Watch

Watches the /src directory and runs build if any changes are made. Add the --styleguide option if you want the styleguilde to be regenerated when changes are made.

gulp watch

Development Server

gulp server

About

Administration UI for the MOTECH Platform

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 50.1%
  • JavaScript 48.1%
  • HTML 1.8%