Skip to content

Frontend of Repository Scanner, which is a Tool to detect secrets in source code management systems.

License

Notifications You must be signed in to change notification settings

abnamro/resc-frontend

Folders and files

NameName
Last commit message
Last commit date
Jun 7, 2024
Feb 29, 2024
Feb 29, 2024
Jul 12, 2024
Jul 12, 2024
Feb 29, 2024
Feb 29, 2024
Feb 29, 2024
Feb 29, 2024
Feb 29, 2024
Feb 29, 2024
Feb 29, 2024
Feb 29, 2024
Feb 29, 2024
Feb 29, 2024
Feb 29, 2024
May 27, 2024
May 27, 2024
Jun 7, 2024
Feb 29, 2024
Feb 29, 2024
Feb 29, 2024
Feb 29, 2024
Feb 29, 2024
Jun 28, 2024
Jul 12, 2024
Feb 29, 2024
Feb 29, 2024
Feb 29, 2024
Feb 29, 2024
Jun 28, 2024
May 8, 2024

Repository files navigation

Repository Scanner Frontend (RESC-Frontend)

Vue.js BootstrapVue Chart.js CI OpenSSF Scorecard SonarCloud

Note

This component is part of Repository Scanner - resc

Table of contents

  1. About the component
  2. Technology stack
  3. Getting started
  4. Additional information

About the component

Repository Scanner (RESC) Frontend is a fully responsive dashboard application developed using Vue.js 2 and BootstrapVue framework. It includes such screens as Analytics, Repositories, Scan Findings, Rule Analytics, and Rule Pack.

Technology stack

Getting started

These instructions will help you to get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  • Install Node.js v16.17.0
  • Install Vue cli using command: npm install -g @vue/cli
  • Install Vetur, ESLint and Prettier extensions to your VSCode IDE.
  • Install Docker
  • Ensure RESC webservice is up and running in order to visualize data. This API is running at http://localhost:30800/.

Run locally

  1. Clone the repository and refer the following steps to run the project locally.
cd components/resc-frontend

npm install

npm run serve
  1. Access the application using this url: http://localhost:8080/

Note: Replace the actual values in the placeholders and

Run using Docker

Build the RESC Frontend Docker image locally by running the following commands.

  • Pull the docker image from registry:
docker pull rescabnamro/resc-frontend:latest
  • Alternatively, build the docker image locally by running:
docker build -t rescabnamro/resc-frontend:latest .
  • Run the RESC frontend by using the following command:
docker run -p 8080:8080 -e VITE_AUTHENTICATION_REQUIRED="false" -e VITE_RESC_WEB_SERVICE_URL="http://localhost:30800/resc"  --name resc-frontend rescabnamro/resc-frontend:latest

Access the application using this url: http://localhost:8080/

Enable or disable Single Sign-On for local run

To enable/disable single sign-on (SSO) set the following values in .env.development file.

Enable SSO:VITE_AUTHENTICATION_REQUIRED=true

Disable SSO:VITE_AUTHENTICATION_REQUIRED=false

Note: Ensure to restart the server by running npm run serve for the change to take effect.

Testing

(Back to top)

Run your unit tests: npm run ut

Linting files: npm run lint

Linting and fixing files: npm run lint:autofix

Additional information

(Back to top)

Useful commands

Compiles and minifies for production: npm run build