igs/portal-ui

UI for IGS project portals such as the HMP data portal found at https://portal.hmpdacc.org.

Buzzwords: #docker #typescript #angularjs #nodejs #gulp

• Technologies
• Installation
• Development
• Contributing
• Production
• Resources

Technologies

• Angular - HTML enhanced for web apps
• AngularUI - The companion suite(s) to the AngularJS framework.
• d3.js - Javascript charting and visualization framework.
• Docker - OS-level virtualization to deliver software in containers.
• Typescript - TypeScript lets you write JavaScript in a more type-safe manner.
• Gulp.js - The streaming build system

Installation

Global Dependencies

Before continuing you must have the following programs installed:

• Node

Setup Script

Running the setup script will:

1. Setup the needed git hook for the project
2. Install npm and bower dependencies

❯ ./setup.sh
commit-msg already exists! Backing up to commit-msg.bak...  OK
Setting up commit-msg git hook...                           OK
Making commit-msg executable...                             OK
Making validate-commit.py executable...                     OK
Confirming Node is installed...                             OK
Installing NPM dependencies...
...
Setup Successful!

Running Locally

Local servers for development are best run with Docker containers. There is included support for Docker Compose.

❯ docker-compose up

Project Dependencies

Project dependencies are managed using NPM

Tests

Unit tests are run with npm.

❯ npm test

Development

The development server is best run with the Docker containers.

❯ docker-compose up

Resources

• angularjs-via-typescript-controllers
• AngularJS + TypeScript : Controllers, Best Practice
• Angular Services using TypeScript : Best Practices