This is a UI web portal built for use with the Duke Data Service API. It is based on gulp, stylus and webpack. The internal data flow is handled with MobX and the routing is managed with the React-Router. The UI is handled by material-ui and a layout grid from Google Material Design Lite.

$ git clone https://github.com/Duke-Translational-Bioinformatics/duke-data-service-portal.git 

Install all dependencies.

$ npm install

Builds the application and starts a webserver with livereload. By default the webserver starts at port 1337. You can define a port with $ gulp --port 3333.

$ gulp

Builds a minified version of the application in the dist folder.

$ gulp build --type production

We use jest to test our application.
You can run the tests that are defined under app/scripts/__tests__ with

$ npm test

In order to test files that are using the react-router we had to add stubRouterContext.jsx which we found here.

The portal interfaces with the [Duke Data Service API](https://github .com/Duke-Translational-Bioinformatics/duke-data-service/tree/master). The API blueprint for Duke Data Service can be found on this API documentation page.

Javascript entry file: app/scripts/main.js

MobX

We are using MobX to manage application state. Mobx makes state management simple and scalable by transparently applying functional reactive programming (TFRP). If you want to read more about MobX, check out the readme of the MobX git repo or the MobX API documentation.

React-Router

The routing is done with the react-router. It's especially great for SPA's. We would recommend to read the guide to get an overview of the router features.

ES6 with babel

We are working with the webpack babel loader in order to load our .js/.jsx files. Babel allows you to use ES6 features like class, arrow functions and much more.

CSS entry file: app/stylus/main.styl

Stylus

As you can see we are using stylus to preprocess our .styl files. If you didn't work with a css preprocessor before the stylus page is a good starting point to get to know what stylus can do for you.

If you want to use third-party CSS you just include it via @import 'path/to/your/third-party-styles.css' at the top of the main.styl file.

You can find the webpack configuration in the webpack.config.js file. We use the babel-loader in order to load .jsx and .js files via webpack. If it's possible install all your dependencies with NPM. Packages installed with NPM can be used like this:

var moduleXYZ = require('moduleXYZ');

You can find all loaders in this list.

###Requirements

• node
• npm
• gulp