https://github.com/npm/statusboard

Public monitor/status/health board for @npm/cli-team's maintained projects
https://github.com/npm/statusboard

board npm-cli open-source status

Last synced: 1 day ago
JSON representation

Public monitor/status/health board for @npm/cli-team's maintained projects

• Host: GitHub
• URL: https://github.com/npm/statusboard
• Owner: npm
• License: other
• Created: 2019-09-05T17:29:00.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T12:25:31.000Z (3 months ago)
• Last Synced: 2024-10-29T13:09:08.813Z (3 months ago)
• Topics: board, npm-cli, open-source, status
• Language: JavaScript
• Homepage: https://npm.github.io/statusboard
• Size: 29.3 MB
• Stars: 155
• Watchers: 17
• Forks: 54
• Open Issues: 86
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
## 📊 statusboard

[**npm.github.io/statusboard**](https://npm.github.io/statusboard/)

A single view to help monitor the status/health of the [`@npm/cli`](https://github.com/orgs/npm/teams/cli) teams's Open Source Projects.

### Data

#### Adding a project

[GitHub search query for `org:npm topic:npm-cli fork:true`](https://github.com/search?q=org%3Anpm+topic%3Anpm-cli+fork%3Atrue&type=repositories)

To be included here a repo must be in the `npm` org and have the `npm-cli` topic added to it. The data is rebuilt daily so the repo should appear by the next day.

Repos are also searched for workspaces via the `package.json#workspaces` array and those are included if they do not have `package.json#private`.

### Removing a project

Projects are removed from the list if they are archived on GitHub and deprecated on the npm registry, or if they are archived and moved to a workspace of another repo we track. The topic `npm-cli` does not need to be removed and should be kept on GitHub repos for historical reference.

### Developing:

#### To update maintained projects:

Locally: `npm run fetch:maintained -w data`

CI: `gh workflow run fetch-maintained.yml`

#### To update daily data:

Locally: `npm run fetch:data -w data`

CI: `gh workflow run fetch-data.yml`

#### Serve / Publish Site

Serve: `npm run dev -w www`

Publish: The site is published to GitHub Pages on all pushes to `main`.

### Forking

This project aims to have some portability, but it will not work out-of-the-box if forked. Here are the things we're aware of that you should change if you fork this:

- Enable the GitHub Action workflows after forking. They are not enabled by default on forked repos

- Update misc links and references to your org

- Delete all historical data from [`workspaces/www/lib/data/**/*.json`](./workspaces/www/lib/data/**/*.json)

- Update the necessary config items in:

  - [`data/lib/config.js`](./workspaces/data/lib/config.js) This controls what data is fetched and filtered from GitHub

  - [`www/lib/js/columns.js`](./workspaces/www/lib/js/columns.js) This is most of how that data get parsed on the frontend for display, sorting, filtering, etc

  - [`www/lib/js/selectors.js`](./workspaces/www/lib/js/selectors.js) These are some data selectors that are shared throughout the frontend

- Have a `AUTH_TOKEN=${{ GITHUB TOKEN}}` in `workspaces/data/.env` if you are fetching data locally. All the data here is from open source repos and packages on the npm registry. So if you're data is private this token will need to have the proper scopes. You can look in [`data/lib/api/`](./workspaces/data/lib/api/) to see all the calls that are made.

- Run `npm run fetch:maintained -w data` and `npm run fetch:data -w data` to populate your new data