https://github.com/pkgjs/statusboard
A status page for community projects
https://github.com/pkgjs/statusboard
Last synced: 15 days ago
JSON representation
A status page for community projects
- Host: GitHub
- URL: https://github.com/pkgjs/statusboard
- Owner: pkgjs
- License: mit
- Created: 2019-08-09T20:23:31.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-07-12T18:13:21.000Z (8 months ago)
- Last Synced: 2025-10-21T16:56:13.641Z (5 months ago)
- Language: JavaScript
- Size: 69.3 KB
- Stars: 23
- Watchers: 2
- Forks: 12
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- stars - statusboard
README
# A Project Status Board
A WIP attempt to centralize all the work being done in a community
of GitHub projects. When you have work spread across multiple repos
and multiple orginizations, it is often hard to track things. This
is what `@pkgjs/statusboard` aims to solve.
This repository is managed by the [Package Maintenance Working Group](https://github.com/nodejs/package-maintenance), see [Governance](https://github.com/nodejs/package-maintenance/blob/master/Governance.md).
## Example
Example statusboards using `@pkgjs/statusboard`:
- - [Github](https://github.com/expressjs/statusboard)
## Setup
WARNING: work in process, the following doesn't work yet, but soon!
The easiest way to create a status board for your project is using Github Pages. To get started, create a new repo for your project and clone it
to your development machine. In the new directory run the following:
```
# Creates a statusboard project
# @TODO make this command actually work as it does not right now
$ npx @pkgjs/statusboard create
# Setup your config in `index.js
# Then commit your work
$ git commit -am "statusboard setup"
# Create an orphan branch for our builds
$ git checkout --orphan gh-pages
# Remove the files we dont need here
$ git rm -rf .
# Create a .nojekyll file, this turns off pesky github pages stuff
$ touch .nojekyll
$ git commit --am "github pages initial commit"
# Now we setup the branch as a working tree on the master branch
$ git checkout master
$ mkdir build
$ git worktree add build gh-pages
# Now we can run the index and build
$ npm run build
# Now we should have a site in ./build, we can
# commit and push the branches now
$ cd build && git add . && git commit -m "our new statuspage" && git push
```
## TODO
- Cli logger
- `create` command to setup a new project
- Contribution graph like on github
- Meetings page (pull tag "meeting")
- Typescript support (load typings or if authored in TS)
- People/Teams (specify and display teams, for example the express TC)
- GH CI status
- Pinned projects