https://github.com/ulisesgascon/poc-openjs-security-program-standards-dashboard
POC - OpenJS Security Program Standards Dashboard
https://github.com/ulisesgascon/poc-openjs-security-program-standards-dashboard
Last synced: 11 months ago
JSON representation
POC - OpenJS Security Program Standards Dashboard
- Host: GitHub
- URL: https://github.com/ulisesgascon/poc-openjs-security-program-standards-dashboard
- Owner: UlisesGascon
- License: mit
- Created: 2024-11-18T22:25:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-18T23:17:46.000Z (over 1 year ago)
- Last Synced: 2024-11-19T00:24:12.222Z (over 1 year ago)
- Language: JavaScript
- Size: 38.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# POC - OpenJS Security Program Standards Dashboard
---
**✨ This POC has evolved into something bigger and fantastic! Check out [OpenPathfinder/visionBoard](https://github.com/OpenPathfinder/visionBoard) ✨**
At this stage, this POC is considered archived, and all development activity has been migrated to [visionBoard](https://github.com/OpenPathfinder/visionBoard).
---
## 📺 Tutorial
If you don't have a good context of this POC motivation, please watch the following video or the slides:
[
](https://youtu.be/B1kd8k5SvBI)
- [slides](https://slides.ulisesgascon.com/openjs-security-program-standards/)
## Installation
To install the dependencies, run:
```sh
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:
```sh
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:
```bash
node index.js workflow run [--name ]
```
To list all available workflows, use the following command:
```bash
node index.js workflow list
```
### Projects
To add a new project, use the following command:
```bash
node index.js project add [--name ] [--github-urls ]
```
For example, to add a project named "express" with GitHub URLs:
```bash
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:
```bash
npm test
```
## Linting
To lint the code, use:
```bash
npm run lint
```
To automatically fix linting errors, use:
```bash
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.