Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 1.26 KB

README.md

File metadata and controls

47 lines (29 loc) · 1.26 KB

AuditWolf

This project was generated with Angular CLI version 6.0.8. This is a mock dashboard with two styles and search capabilities which consume the Audit Wolf's XML rest API.

How to run

Make sure angular is installed on your device.

  1. cd PROJECTDIR
  2. npm install
  3. ng serve or ng serve -o

Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Running tests

Unfortunately due to time constraints no unit tests were written.

File structure

There are three main parts of the application Services, Components, and Models

Services

We use it for consume the XML Rest API

Components

Since we are using angular we are using a template based approach which allows users to resume a lot of the components thus making code reusability very good for this application.

Models

We use models to get Issue object

Librries

Lodash

Provides useful functions such as filtering documentation - https://lodash.com/

Material UI

Provides neat components and navigations documentation - https://material.angular.io/

SCSS

A more powerful version of css documentation - https://sass-lang.com/