README.md

Scope

Scope is a security breach visualization tool that gives you insight into cyber crime around the world.

• Uses data from the Veris database of breach information
• View graphical representations of breach data by country
• View graphical representations of breach data by company
• Filter, sort, and view company data in a table that includes pagination

Why I created Scope?

• I wanted to create an end to end project from scratch that might be of interest to people in the security community
• I wanted to increase my presence on github
• I needed to get my hands on a good side project

Why Scope is right for you?

• Do you enjoy looking a graphical representations of data and have an affinity for security? You have made it to the right place.
• Interested in using graphs for your angular project? There are many examples in my codebase.
• Are looking for the right person for the job and are browsing Github to find them? Take a look at my coding style.

While you are here...

• You can use my graphing service for your own graphing needs
• Take a dive into my implementation of h2 integration with liquibase and spring boot
• Browse my configuration for testing the DAO layer with H2
• Use the data set that I transformed for your own project
• Take a look at the python script I created for ETL
• Utilize my Travis and Docker files to help set up a project with the same architecture

Technology stack

Front end

• Angular
• Typescript
• SCSS

Back end

• Java
• Spring
• Spring boot
• H2
• Maven
• Liquibase

Deployment

• Docker

ETL

• Python

Data set

• Data was retrieved from Veris Community Database (http://veriscommunity.net/vcdb.html)
• Data was transformed using a custom python script

How to run?

Prerequisites

• Install Docker
• Maven
• Angular CLI

Deployment

To build docker containers together:

• Download and unpack the zip file
• CD into the root directory

Run the following docker commands to start up the application:

docker-compose up

To build docker containers separately:

• Download and unpack the zip file
• CD into the Frontend/data-breach-visualization directory

Run the following docker commands to start up the front end:

docker build -t scope-frontend .
docker run -p 80:80 -it scope-frontend

CD into the Backend/security-breach-data directory

Run the following docker commands to start up the back end:

docker build -t scope-backend .
docker run -it -p 8080:8080 scope-backend

You are up and running! Navigate to link http://localhost:80 to start using the website.

How to run test suites?

To run frontend tests:

• CD into the Frontend/data-breach-visualization
• Run the following Angular CLI commands to run tests:

ng test

To run backend tests:

• CD into the Backend/security-breach-data directory
• Run the following Maven commands to run tests:

mvn clean test

DB configuation

An in memory H2 database will be created and liquibase scripts will be run to create tables and insert data.

Access API Documentation with Swagger

• Start up the backend docker container
• Navigate to link http://localhost:8080/swagger-ui.html