VIR-Frontend

Introduction

VIR-Frontend App built using the following:

Developed using boostrap-v4.0.0-alpha.6
ng-bootstrap
angular-v4.3.1
angular/cli-v1.3.2
Official Angular i18n support.
SCSS
HTML5

How to start

Note that this seed project requires node >=v6.9.0 and npm >=3.

In order to start the project use:

$ git clone git@github.com:FIU-SCIS-Senior-Projects/VIR-2.0.git
$ cd VIR-2.0/Code/VIR-Frontend
# install the project's dependencies
$ npm install
# watches your files and uses livereload by default run `npm start` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
$ npm start
# prod build, will output the production application in `dist`
# the produced code can be deployed (rsynced) to a remote server
$ npm run build

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive/pipe/service/class/module.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor. Before running the tests make sure you are serving the app via ng serve.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

Documentation

install it with npm :
```
$ npm i -g @compodoc/compodoc
```
run it inside the folder of your Angular application
```
$ compodoc -p tsconfig.json
```
You can then run an HTTP server in that folder, or launch the previous command with the -s flag, and the tool will serve you the documentation, by default on http://localhost:8080
```
$ compodoc -p tsconfig.json -s
```