jameswlane / statusboard Goto Github PK

jameswlane.github.io/statusboard

A single view to help monitor the status/health of my Open Source Projects.

GitHub search query for org:jameswlane topic:jwl-sb fork:true

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.

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.

Locally: npm run fetch:maintained -w data

CI: gh workflow run fetch-maintained.yml

Locally: npm run fetch:data -w data

CI: gh workflow run fetch-data.yml

Serve: npm run dev -w www

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

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
• Update the necessary config items in:
  • data/lib/config.js This controls what data is fetched and filtered from GitHub
  • 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 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/ 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