repo-utils/badgeboard

template for *.github.io's

Pulling from here:

~/your-org.github.io$ git pull https://github.com/repo-utils/badgeboard.git
~/your-org.github.io$ make ; make db
~/your-org.github.io$ git commit index.html src/db.json -m 'rebuild'
~/your-org.github.io$ git push

You'll probably need to resolve merge conflicts after you do git pull.

Creating new badgeboard:

1. clone this repo

~$ git clone https://github.com/repo-utils/badgeboard.git your-org.github.io

2. change config.yaml

3. change .gitignore, unignore autogenerated files, see comments there. Specifically, you want to uncomment index.html from the .gitignore.

4. make it:

~/your-org.github.io$ make

5. test it:

~/your-org.github.io$ firefox index.html

6. add autogenerated files so they will appear on github pages:

~/your-org.github.io$ git add src/db.json index.html
~/your-org.github.io$ git commit src/db.json index.html -m 'rebuild'

Deployment Methods

There are two ways to deploy the badge board. The first is to deploy it at https://<your-org>.github.io. To do so, simply push your badgeboard to https://github.com/<your-org>/<your-org>.github.io.

The second way is to deploy it to a URL like https://<your-org>.github.io/badgeboard. You may prefer this method if you are already have a page for your GitHub organization. To do so, push your badgeboard to https://github.com/<your-org>/badgeboard and change the default branch to gh-pages instead of master. Of course, you don't have to name the repository badgeboard - you can name it whatever you'd like.

badgeboard's Issues

sort keys in db.json

now it outputs stuff in random order depending on your internet connection, which messes up git diffs

default settings in this repo

Okay, as I said in #1, I don't know what the default settings here should be.

For example, recently jshttp/http-utils repo was created, should we add it here or not? If yes, we'll essentially have two identical repos. If not, this repo will be just an outdated version of that one. Weird.

template adds jshttp header to everyone's board

see pillarjs#2

offending code is at: https://github.com/repo-utils/badgeboard/blob/master/templates/layout.jade#L18-L22

tests

Technically all existing tests for this repository pass right now.

But I think we need to actually add at least one.

too sloooow

As far as I remember, browser limits requests to 6 per domain, and we have 108 badges in jshttp now...

Is there any way to speed that up? Draw them using js for example, and fetch it all in one request from somewhere with a decent cache.

Do shields.io have some kind of bulk-retrieve api?

creating a template

See:
jshttp/jshttp.github.io#2 (comment)

We need some real data in this template (so people will have working template before they even change anything). And jshttp data is as good as any.

So I don't see how this repo would be any different from jshttp.github.io (apart from minor style changes there, and deployment instructions here).

[footgun] referencing issues from here

... can close issues in other repos.

Because when you push commits from here to there, github thinks that you want to close commits in that repo, not in this one.

jshttp/jshttp.github.io#6
jshttp/jshttp.github.io#11

@jonathanong , any workarounds?

related orgs

Way to add a blurb/description

branch to gh-pages, make it the default branch

# of dependents

would be cool to see how many dependents a package has

better badges for repos without tests?

would be nice to show stuff like a discussion repo or a repo like "logger" that might not have any tests

use shields.io node version badge

shields.io now has the node.js version badge!

http://img.shields.io/node/v/<module>.svg

config: google analytics code

make it easy to track visits

allow users to do repo: x which expands to <org>/x

when repo name doesn't match the npm name

branch for tests and coverage?

not sure what it does now, but i've sometimes seen tests fail because a PR test fails. we should point it to master.

stuff that doesn't support node.js

i.e. client-side stuff. we need the ability to hide the badge and maybe grab the latest semver tag instead of the lastest npm version

Author repo count stale

It seems like the http://isaacs.iriscouch.com/ call is returning stale data these days. I wonder if there is a new way to get this count?

Add a link to this repo on the built page

So people know they can make their badgeboard

Pull more author info from npm

The author data page now contains the GitHub name and Twitter handle; probably don't need to manually track that in the YAML file any longer.

npm scripts point to wrong dir

The scripts section in the package file point to src/ instead of scripts/ :)

some sort of "# of possible contributions" badge

people always email us asking how they could contribute. would be cool to somehow get all the help wanted issues in each repo and make that a badge. not sure what to call them though. maybe also an input wanted badge as well

bail if no travis is found

because some of my shit don't have tests :D

github stars and forks

once we figure out how to avoid all those iframes and stuff

table sorting

be able to sort by one of the columns, specifically maintainers

browser support badge?

yes/no, but min browser versions if we're feeling crazy haha. is there a package.json field for this?

improve avatars

jshttp/jshttp.github.io@a8d6f18#commitcomment-7600350

just hardcode that in config if missing

stream of latest releases of modules

stability

stable, unstable, and experimental, defaulting to stable if v1+.

it'll just be a warning to users on how to use the module. ex. templation would be experimental but it's already v1 because i want to cohere to semver anyways. cookie and cookies would be unstable because we plan to drastically rewrite and refactor it.