Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mntnr/dashboard
A status board for repositories within a GitHub organization.
https://github.com/mntnr/dashboard
dashboard github maintainer organization vitality
Last synced: 5 days ago
JSON representation
A status board for repositories within a GitHub organization.
- Host: GitHub
- URL: https://github.com/mntnr/dashboard
- Owner: mntnr
- License: other
- Created: 2017-08-22T14:28:38.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-11-22T00:37:12.000Z (almost 2 years ago)
- Last Synced: 2024-06-21T07:19:33.379Z (5 months ago)
- Topics: dashboard, github, maintainer, organization, vitality
- Language: CSS
- Homepage: https://maintainer.io
- Size: 1.41 MB
- Stars: 21
- Watchers: 3
- Forks: 4
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-starred - mntnr/dashboard - A status board for repositories within a GitHub organization. (github)
README
# Maintainer Dashboard
> Maintainer GitHub Dashboard
This is a status board for repositories within a GitHub organization.
It displays build health, and other measures that your community should care about!Hosted on IPFS!
![Screenshot](screenshot.png)
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [Local development](#local-development)
- [Deploy](#deploy)
- [Contribute](#contribute)
- [License](#license)## Background
This work started with [ipfs/project-repos](https://github.com/ipfs/project-repos). However, as I needed to do some work on it and wanted it to be extendable beyond IPFS, and as I did not have access to the issues for that repository, I have forked it, deleted the history, and made my own copy, here.
## Install
Simply clone this repo.
## Usage
### Local development
To recompile continuously, and start a development server with hot reloading:
npm run dev
To build minified javascript for production:
npm run build
### Token
You will need a GitHub token in order to have more requests available to you, as this is a very request-heavy tool. Set it in your environment as `MAINTAINER_DASHBOARD`, or include this token in the `data.json` config in a `token` field.
### Enterprise
Add a `rootURL` field to `data.json` with the endpoint needed.
## Deploy
To deploy this, after merging any new PRs, follow these steps:
1. Have an ipfs daemon running: `ipfs daemon`
2. Kill your `npm run dev` script if you happen to have it running.
3. `npm install && npm prune`
4. `npm run publish`. This should open the published page on the gateway.
5. Pin the hash: `ipfs pin add `
6. Pin the hash to the gateways, on IRC: `!pin project-repos.ipfs.io`
7. Post the hash and url to https://github.com/ipfs/ops-requests/issues.## Contribute
If you would like to contribute code to this repository, please dive in! Check out [the issues](//github.com/mntnr/dashboard/issues).
## License
[MIT](LICENSE)