POC - OpenJS Security Program Standards Dashboard

---

✨ This POC has evolved into something bigger and fantastic! Check out OpenPathfinder/visionBoard ✨

At this stage, this POC is considered archived, and all development activity has been migrated to visionBoard.

---

📺 Tutorial

If you don't have a good context of this POC motivation, please watch the following video or the slides:

• slides

Installation

To install the dependencies, run:

npm install

Configuration

Environment Variables

This project requires a GitHub token to access the GitHub API. You need to set the GITHUB_TOKEN environment variable.

Optional: use .env file

Create a .env file and add your GitHub token:

GITHUB_TOKEN=your_github_token_here

then use --env-file flag to load it, like node --env-file=.env index.js workflow run --name populate-repos-list

Usage

Workflows

To run a workflow, use the following command:

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

To list all available workflows, use the following command:

node index.js workflow list

Projects

To add a new project, use the following command:

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

For example, to add a project named "express" with GitHub URLs:

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

Running Tests

To run the tests, use:

npm test

Linting

To lint the code, use:

npm run lint

To automatically fix linting errors, use:

npm run lint:fix

Continuous Integration

This project uses GitHub Actions for continuous integration. The configuration is in the .github/workflows/ci.yml file. The CI pipeline runs on every push and pull request, and it includes the following steps:

• Install dependencies
• Lint code
• Run tests

License

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