No description or website provided.
Latest commit 556ddd6 Oct 17, 2018
Permalink
Failed to load latest commit information.
.github Init Commit Oct 7, 2016
.vscode NGPOC-302:Add functionality to change visit location Jun 5, 2017
config NGPOC-383:Add ability to include dynamic form alerts Sep 14, 2017
src Removed piwik Oct 17, 2018
.angular-cli.json NGPOC-391:Upgrade tooling for ng2-amrs Aug 11, 2017
.angulardoc.json NGPOC-453: Added referral features for differentiated care Sep 21, 2017
.bootstraprc Change theme Oct 17, 2016
.editorconfig Init Commit Oct 7, 2016
.gitignore Added angular doc file to git ignore Sep 29, 2017
.nvmrc Init Commit Oct 7, 2016
.release.json NGPOC-205:Setup an automated release process release major,minor,patch Mar 17, 2017
.travis.yml Added Dockerfile and docker-compose.yml Mar 21, 2018
CONTRIBUTING.md NGPOC-409:Add program enrollment validation for mutually exclusive pr… Sep 22, 2017
Dockerfile Added Dockerfile and docker-compose.yml Mar 21, 2018
LICENSE Init Commit Oct 7, 2016
README.md NGPOC-205:Setup an automated release process release major,minor,patch Mar 17, 2017
create-snapshot.js NGPOC-205:Setup an automated release process release major,minor,patch Mar 17, 2017
docker-compose.yml Added Dockerfile and docker-compose.yml Mar 21, 2018
karma.conf.js NGPOC-391:Upgrade tooling for ng2-amrs Aug 11, 2017
package-lock.json Retrospective Data Entry Module Aug 23, 2018
package-snapshot.js NGPOC-205:Setup an automated release process release major,minor,patch Mar 17, 2017
package.json Retrospective Data Entry Module Aug 23, 2018
protractor.conf.js NGPOC-391:Upgrade tooling for ng2-amrs Aug 11, 2017
tsconfig.json NGPOC-391:Upgrade tooling for ng2-amrs Aug 11, 2017
tsconfig.webpack.json NGPOC-391:Upgrade tooling for ng2-amrs Aug 11, 2017
tslint.json NGPOC-420:Update post order details based on user requests Aug 16, 2017
typedoc.json Init Commit Oct 7, 2016
typings.json NGPOC-44: Create encounter resource service Nov 16, 2016
version.ejs NGPOC-391:Upgrade tooling for ng2-amrs Aug 11, 2017
webpack.config.js NGPOC-391:Upgrade tooling for ng2-amrs Aug 11, 2017

README.md

##Ampath Point of Care System Version 2 Build Status

Quick start

Make sure you have Node version >= 5.0 and NPM >= 3

Clone/Download the repo then edit app.ts inside /src/app/app.ts

# clone our repo
# --depth 1 removes all but one .git commit history
git clone --depth 1 https://github.com/AMPATH/ng2-amrs.git

# change directory to our repo
cd ng2-amrs

# install the repo with npm
npm install

# start the server
npm start

# use Hot Module Replacement
npm run server:dev:hmr

# if you're in China use cnpm
# https://github.com/cnpm/cnpm

go to http://0.0.0.0:3000 or http://localhost:3000 in your browser

Table of Contents

File Structure

This is the folder sturucture of the app style, template, specs, e2e, and component class. Here's how it looks:

angular2-webpack-starter/
 ├──config/                    * our configuration
 |   ├──helpers.js             * helper functions for our configuration files
 |   ├──spec-bundle.js         * ignore this magic that sets up our angular 2 testing environment
 |   ├──karma.conf.js          * karma config for our unit tests
 |   ├──protractor.conf.js     * protractor config for our end-to-end tests
 │   ├──webpack.dev.js         * our development webpack config
 │   ├──webpack.prod.js        * our production webpack config
 │   └──webpack.test.js        * our testing webpack config
 │
 ├──src/                       * our source files that will be compiled to javascript
 |   ├──main.browser.ts        * our entry file for our browser environment
 │   │
 |   ├──index.html             * Index.html: where we generate our index page
 │   │
 |   ├──polyfills.ts           * our polyfills file
 │   │
 |   ├──vendor.ts              * our vendor file
 │   │
 │   ├──app/                   * WebApp: folder
 │   │   ├──app.spec.ts        * a simple test of components in app.ts
 │   │   ├──app.e2e.ts         * a simple end-to-end test for /
 │   │   └──app.ts             * App.ts: a simple version of our App component components
 │   │
 │   └──assets/                * static assets are served here
 │       ├──icon/              * our list of icons from www.favicon-generator.org
 │       ├──service-worker.js  * ignore this. Web App service worker that's not complete yet
 │       ├──robots.txt         * for search engines to crawl your website
 │       └──humans.txt          * for humans to know who the developers are
 │
 │
 ├──tslint.json                * typescript lint config
 ├──typedoc.json               * typescript documentation generator
 ├──tsconfig.json              * config that webpack uses for typescript
 ├──package.json               * what npm uses to manage it's dependencies
 └──webpack.config.js          * webpack main configuration file

Getting Started

Dependencies

What you need to run this app:

  • node and npm (brew install node)
  • Ensure you're running the latest versions Node v4.x.x+ (or v5.x.x) and NPM 3.x.x+

If you have nvm installed, which is highly recommended (brew install nvm) you can do a nvm install --lts && nvm use in $ to run with the latest Node LTS. You can also have this zsh done for you automatically

Once you have those, you should install these globals with npm install --global:

  • webpack (npm install --global webpack)
  • webpack-dev-server (npm install --global webpack-dev-server)
  • karma (npm install --global karma-cli)
  • protractor (npm install --global protractor)
  • typescript (npm install --global typescript)
  • release-it (npm install --global release-it)

Releasing the app

  • checkout maintenance branch (git checkout -b 2.2.x or git checkout 2.2.x)
  • npm run release

Installing

  • fork this repo
  • clone your fork
  • npm install webpack-dev-server rimraf webpack -g to install required global dependencies
  • npm install to install all dependencies
  • npm run server to start the dev server in another tab

Running the app

After you have installed all dependencies you can now run the app. Run npm run server to start a local server using webpack-dev-server which will watch, build (in-memory), and reload for you. The port will be displayed to you as http://0.0.0.0:3000 (or if you prefer IPv6, if you're using express server, then it's http://[::1]:3000/).

server

# development
npm run server
# production
npm run build:prod
npm run server:prod

Other commands

build files

# development
npm run build:dev
# production
npm run build:prod

hot module replacement

npm run server:dev:hmr

watch and build files

npm run watch

run tests

npm run test

watch and run our tests

npm run watch:test

run end-to-end tests

# make sure you have your server running in another terminal
npm run e2e

run webdriver (for end-to-end)

npm run webdriver:update
npm run webdriver:start

run Protractor's elementExplorer (for end-to-end)

npm run webdriver:start
# in another terminal
npm run e2e:live

build Docker

npm run build:docker

Configuration

Configuration files live in config/ we are currently using webpack, karma, and protractor for different stages of your application

Contributing

You can include more examples as components but they must introduce a new concept such as Home component (separate folders), and Todo (services). I'll accept pretty much everything so feel free to open a Pull-Request

TypeScript

To take full advantage of TypeScript with autocomplete you would have to install it globally and use an editor with the correct TypeScript plugins.

Use latest TypeScript compiler

TypeScript 1.7.x includes everything you need. Make sure to upgrade, even if you installed TypeScript previously.

npm install --global typescript

Use a TypeScript-aware editor

We have good experience using these editors:

Visual Studio Code + Debugger for Chrome

Install Debugger for Chrome and see docs for instructions to launch Chrome

The included .vscode automatically connects to the webpack development server on port 3000.

Types

When you include a module that doesn't include Type Definitions inside of the module you can include external Type Definitions with @types

i.e, to have youtube api support, run this command in terminal:

npm i @types/youtube @types/gapi @types/gapi.youtube

In some cases where your code editor doesn't support Typescript 2 yet or these types weren't listed in tsconfig.json, add these to "src/custom-typings.d.ts" to make peace with the compile check:

import '@types/gapi.youtube';
import '@types/gapi';
import '@types/youtube';

Custom Type Definitions

When including 3rd party modules you also need to include the type definition for the module if they don't provide one within the module. You can try to install it with @types

npm install @types/node
npm install @types/lodash

If you can't find the type definition in the registry we can make an ambient definition in this file for now. For example

declare module "my-module" {
  export function doesSomething(value: string): string;
}

If you're prototyping and you will fix the types later you can also declare it as type any

declare var assert: any;
declare var _: any;
declare var $: any;

If you're importing a module that uses Node.js modules which are CommonJS you need to import as

import * as _ from 'lodash';

Frequently asked questions

Support, Questions, or Feedback

Contact us anytime for anything about this repo or Angular 2

How to add App Analytics as you code

This project is configured with angulartics with piwik as the analytics provider. It is important to track events and actions as you code. Here is a basic quide on how to do this:

Import AppFeatureAnalytics Service in your component, service, directive or pipe

import { AppFeatureAnalytics } from '../../shared/services/app-feature-analytics.service.ts';

... and inject it

constructor(private appFeatureAnalytics: AppFeatureAnalytics) {}

then call this.appFeatureAnalytics.trackEvent() with the following parameters

  • @param {string} category --> The Module/Dashboard eg 'Patient Dashboard'
  • @param {string} action --> The Feature you want to track eg 'Searching Patient'
  • @param {string} [name] --> The name of the function trackEvent() fx was invoked eg 'searchPatient'
  public searchPatient(event: any) {
    //.... functionality of your method
    this.appFeatureAnalytics.trackEvent('Patient Dashboard', 'Searched Patient', 'searchPatient');
  }

License

MIT