VisionBoard

Transforming Data into Actionable insights

This project aims to provide a secure and user-friendly dashboard for managing and monitoring projects under the OpenJS Foundation. It evolves from this proof of concept (POC) and currently we are developing an MVP version (milestone roadmap).

Table of Contents

1. Motivation
   • More context
   • Engage now
2. Getting Started
   • Prerequisites
   • Infrastructure Setup
   • Configuration
3. Usage
   • Projects
   • Workflows
   • Checks
4. Report Management
5. Database Management
   • Migrations
   • Seeding
   • Schema Management
6. Development
   • Debugging
   • Linting
   • Testing
7. Community Guidelines
8. License

Motivation

The goal of this project is to streamline the secure management of OpenJS Foundation projects by providing an intuitive dashboard with robust infrastructure support. It emphasizes security, simplicity, and extensibility ✨

More Context

A few months ago, we started a discussion about the OpenJS Security Collab space initiative ("Security Program Standards") to build a dashboard for monitoring security parameters in our projects (Node.js, Electron, jQuery, Express, etc.). After carefully planning and securing resources, we are now at an exciting point as we’ve recently launched a pilot program with some projects. 🚀

So far, we’ve developed this website: https://openjs-security-program-standards.netlify.app/, which is based on the checklist (Google Sheet) and the introductory document (Google Doc) that we compiled during our original research. 😄

You can watch this YouTube video for a proper introduction to the Dashboard and website (both Proof of Concept versions) built based on feedback from the Express Security WG and others.

In essence, this tool collects information from multiple sources, evaluates it, transforms it into actionable insights, and uses it to build dashboards, tasks, and alerts at both the foundation and project levels. If you prefer a non-video format, here are the slides and the code repository.

Currently, we are focused on building a solid MVP and onboarding new contributors, aiming to create a great product by the end of this process. 😎

Engage Now

Yes, we are looking for HELP in many ways! 😇 Let’s collaborate and have fun together. You can find more information in the contributing guide. 🌟

Another great way to get involved is by participating in the OpenJS Security Collab Space. We hold regular meetings to discuss this initiative and many other exciting topics.

The project includes a technical architecture guide that provides in-depth explanations of various concepts.

Getting Started

Prerequisites

• Node.js 22 and npm
• Docker and Docker Compose
• GitHub token with repo:read access level (not needed for development)

Infrastructure Setup

This project requires a PostgreSQL database and includes an instance of Adminer accessible at http://localhost:8080.

Start Infrastructure

npm run infra:start

Stop Infrastructure

npm run infra:stop

Configuration

Environment Variables

Set the GITHUB_TOKEN environment variable to authenticate with the GitHub API.

Optionally, use a .env file:

GITHUB_TOKEN=your_github_token_here

Then load it using:

node --env-file=.env visionboard.js workflow run --name populate-repos-list

Usage

Projects

Add a new project:

node visionboard.js project add [--name <name>] [--github-urls <urls...>]

Example:

node visionboard.js project add --name express --github-urls https://github.com/expressjs https://github.com/pillarjs https://github.com/jshttp

Workflows

Run a workflow:

node visionboard.js workflow run [--name <name>]

List workflows:

node visionboard.js workflow list

Checks

List all checks:

node visionboard.js check list

Run a specific check:

node visionboard.js check run [--name <name>]

There is an specific workflow that runs all the checks sequentially:

node visionboard.js workflow run run-all-checks

Checklist

The checklist are collections of checks. You can list the available list by running:

node visionboard.js checklist list

Run a specific checklist:

node visionboard.js checklist run [--name <name>]

It is possible also to define a project scope:

node visionboard.js checklist run [--name <name>] [--project-scope <name1,name2,...>]

Report Management

visionBoard has the capability of generating reports that can be used to analyze data.

Generate the Reports

Not yet implemented

Showcase the Reports

The simplest option is to run the workflow show-reports, which will start an HTTP server that lists the content in the output folder. Any asset previously generated can be accessed via a web browser using this approach. You can start the server by running:

node visionboard.js workflow run --name show-reports

You can customize the IP and port using the environment variables PORT and IP. By default, it uses localhost:3000.

Database Management

Migrations

Run latest migrations:

npm run db:migrate

Rollback migrations:

npm run db:rollback

Seeding

Seed the database:

npm run db:seed

Schema Management

Check the schema:

Refer to the latest schema file at /src/database/schema/schema.sql.

Update the schema:

npm run db:generate-schema

Development

Debugging

Enable debug logs using the DEBUG environment variable:

DEBUG=* node visionboard.js

Linting

Run lint checks:

npm run lint

Fix lint issues:

npm run lint:fix

Testing

Run tests:

npm test

Run tests with coverage:

npm run test:coverage

Update the snapshots when needed:

npm run test -- -u

Community Guidelines

We encourage contributors to adhere to our Code of Conduct and Contributing Guidelines. Security-related concerns should follow our Security Policy.

License

This project is licensed under the MIT License. See the LICENSE file for details.