A web application built for the staffs of NCRAR to aid them in research and to better serve patients who are suffering from tinnitus.

Featuring the following frameworks:

An Angular starter kit featuring Angular 4, Ahead of Time Compile, Router, Forms, Http, Services, Tests, E2E), Karma, Protractor, Jasmine, Istanbul, TypeScript, @types, TsLint, Codelyzer, Hot Module Replacement, and Webpack 2 by AngularClass.

The following instruction will show you how to get the project running in your local environment for development and testing.

• NodeJs LTS and Npm
• Git Bash for MacOS or TortoiseGit for Windows

• Webstorm 10
• Atom with TypeScript plugin

After installing the Node.js and Npm you should be ready to clone our repository. Open up Git Bash or Console and enter the following commands with administrator privilege

1. Clone the repo

# Make note of the directory location
git clone https://github.com/marissa-hagglund/VA-Audiology-Website.git

2. Go into the git repo directory

cd YOUR_REPO_LOCATION/VA-Audiology-Website

3. Install all the necessary packages with Npm

npm install -g node-pre-gyp

# This step may take longer
npm install

If you run into issues with node-sass when running "npm install" on MacOS, try running this command first:

npm install node-sass

All the packages required for the project are now installed, you are now ready to run the application locally with the following commands:

# Be sure that you in the project directory first
npm start

Your default browser should open up the application. If not enter the following link into your browser.

http://localhost:3000/

To run the unit tests, first change into your repo's directory and enter the following commands:

npm test

This will trigger lint to run first then all of the unit tests.

Run protractor with the following commands

npm run protractor

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

Any stylesheets (Sass or CSS) placed in the src/styles directory and imported into the project will automatically be compiled into an external .css and embedded in the production builds.

For example using Bootstrap as an external stylesheet:

1. Create a styles.scss file (name doesn't matter) in the src/styles directory.
2. Use npm install to install desired Bootstrap version
3. In styles.scss add @import 'bootstrap/scss/bootstrap.scss';
4. In src/app/app.module.ts add the import statements: import '../styles/styles.scss';

New components can be added by using the following command:

ng generate component [your_compment_name]

This should generate all the necessary files in the src\app\ folder.
Be sure to add your component to app.module.ts file.
Depending on the what you are working on, you will also need to add your component to the declarations: [ ] in @NgModule;

New modules can be installed using Npm with the following command:

npm install [package name]

Depending on the module, you may also need to add the module to import: [ ] and export: [ ] in @NgModule.
You may still need to import in the module in the component that uses it.

Before creating Pull Request; all unit tests should be passing and coverage should be 100% and there should not be any lint errors. After three the Pull Request has been approved by three people the it will be merged into master.

National Center for Rehabilitative Auditory Research (NCRAR) at the OHSU VA
Candice Manning

Portland State University Computers Science Department
Bart Massey

Team Lead:

• Marcus Brambora

Team Members:

• Dan Corcoran
• Suleman Tarik
• Selmon Afzal
• Sam Cha
• Joe Sands
• Ryan Moore

This project is licensed under the MIT License - see the LICENSE.md file for details