Skip to content

Scopeon-sec/scopeon-web

Repository files navigation

ScopeonWeb - CVE Scanner Frontend

Angular-based frontend for the Scopeon CVE Scanner vulnerability management system.

Quick Start

1. Setup Certificates

# See detailed instructions in certs/README.md
cd certs/
mkcert localhost 127.0.0.1 ::1
cd ..

2. Install Dependencies

npm install

3. Generate API Client

# Generate TypeScript API client from OpenAPI spec
npx @openapitools/openapi-generator-cli generate \
  -i src/api/swagger.json \
  -g typescript-angular \
  -o src/app/api/generated \
  --additional-properties=ngVersion=18,npmName=scopeon-api,fileNaming=kebab-case

4. Start Development Server

ng serve --ssl --ssl-cert certs/localhost.pem --ssl-key certs/localhost-key.pem

Navigate to https://localhost:4200/ (note HTTPS)

API Client

The TypeScript API client is generated from the OpenAPI specification and is not tracked in git.

Regenerate API Client

npx @openapitools/openapi-generator-cli generate \
  -i src/api/swagger.json \
  -g typescript-angular \
  -o src/app/api/generated \
  --additional-properties=ngVersion=18,npmName=scopeon-api,fileNaming=kebab-case

Note: Run this command whenever the OpenAPI spec (src/api/swagger.json) is updated.

Important Setup

⚠️ Certificate Setup Required: This application requires HTTPS certificates for development and production.

📖 Certificate Setup Guide - Complete instructions for development and production certificates

📋 Certificate Management - Production deployment strategies

Project Structure

src/
├── app/
│   ├── core/                 # Core services (auth, interceptors, guards)
│   ├── features/            # Feature modules (auth, dashboard)
│   ├── shared/              # Shared components and utilities
│   └── environments/        # Environment configurations
├── certs/                   # TLS certificates (not tracked in git)
└── docs/                    # Documentation

Development Server

To start a local development server, run:

ng serve --ssl --ssl-cert certs/localhost.pem --ssl-key certs/localhost-key.pem

The application will automatically reload whenever you modify any of the source files.

Authentication

The application includes a complete authentication system:

  • Secure login with session cookies
  • CSRF protection
  • Route guards
  • Automatic logout on session expiry

Default development credentials (if enabled):

  • Username: admin
  • Password: SecureAdminPassword123!

Code scaffolding

Angular CLI includes powerful code scaffolding tools. To generate a new component, run:

ng generate component component-name

For a complete list of available schematics (such as components, directives, or pipes), run:

ng generate --help

Building

To build the project run:

ng build

This will compile your project and store the build artifacts in the dist/ directory. By default, the production build optimizes your application for performance and speed.

Running unit tests

To execute unit tests with the Karma test runner, use the following command:

ng test

Running end-to-end tests

For end-to-end (e2e) testing, run:

ng e2e

Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.

Additional Resources

For more information on using the Angular CLI, including detailed command references, visit the Angular CLI Overview and Command Reference page.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages