PulseTile is a clinically led UX UI framework for healthcare.
See PulseTile Documentation for detailed documentation on the framework.
This repo includes the Core UI Framework and "Core Tiles"
See this repo for other PulseTile "Plugin Tiles"
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
To develop and run the application locally you must have the following installed:
- NodeJS
- A running version of The Ripple Middleware listening on port 19191
The first step to setup the application locally should be the following:
npm install
bower install
PulseTile uses Webpack to build and launch the development environment. After you have installed all dependencies, you may run the app. Running npm start will bundle the app with webpack, launch a development server, and watch all files. The port will be displayed in the terminal.
Just simply run npm start - this will also watch changes.
Here's a list of available scripts:
npm run build- runs Webpack, which will transpile, concatenate, and compress (collectively, "bundle") all assets and modules into
dist/bundle.js. It also preparesindex.htmlto be used as application entry point, links assets and created dist version of our application.
- runs Webpack, which will transpile, concatenate, and compress (collectively, "bundle") all assets and modules into
npm start- starts a dev server via
webpack-dev-server, serving the client folder with watching source file change.
- starts a dev server via
npm run lint- lint codebase using Eslint
npm run copy- ignore this in case you don't need the additional plugins installation (see below for further instructions)
PulseTile uses Webpack together for its build system.
Webpack handles all file-related concerns:
- Transpiling from ES6 to ES5 with
Babel - Loading HTML files as modules
- Transpiling stylesheets and appending them to the DOM
- Refreshing the browser and rebuilding on file changes
- Hot module replacement for transpiled stylesheets
- Bundling the app
- Loading all modules
- Doing all of the above for
*.spec.jsfiles as well
Angular 1.5 use for modular structure.
Additional information on such topics as data structure we're using is available within the PulseTile Documentation
NB Note that the PulseTile Framework is easiest to understand/experiment with in the context of a wider healthcare stack.
Please check out the Ripple Foundation Showcase Stack Documentation for a better understanding of PulseTile in that context. One of the features available is an install script that gets PulseTile up and running with a set of API provided test data ready to explore.
This product /project is supported by the Ripple Foundation, who aim to enhance the PulseTile framework, as part of our mission towards an open platform in healthcare.. We are working to fund as many of the enhancements of PulseTile as we can based on projects that our non profit organisation supports.
We will try to fix any key bugs and documentation errors ourselves. Other issues, requests for enhancements or feature additions, will be added to the project backlog.
The Ripple Foundation is committed to offering free and open software, with quality, free and open documentation, but unfortunately is unable to offer free support for all issues/pull requests in the backlog.
(Our latest thinking on the best model to support our open platform mission in healthcare may best be understood by reading this article. https://opensource.com/business/16/4/refactoring-open-source-business-models
If you would like to offer some of your energy/ suggest other ideas towards progressing an open platform in healthcare, please contact us at info@ripple.foundation )
If you need support with a particular issue/pull request, please let us know and we can consider a bounty source (https://www.bountysource.com/), to get these reviewed / addressed.
Thanks for your interest in PulseTile
The Ripple Foundation http://ripple.foundation/