https://github.com/repo-utils/badgeboard
template for *.github.io's
https://github.com/repo-utils/badgeboard
Last synced: about 2 months ago
JSON representation
template for *.github.io's
- Host: GitHub
- URL: https://github.com/repo-utils/badgeboard
- Owner: repo-utils
- License: mit
- Created: 2014-08-18T07:48:59.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2023-03-26T08:24:18.000Z (over 2 years ago)
- Last Synced: 2024-03-25T20:21:10.729Z (over 1 year ago)
- Language: JavaScript
- Size: 60.5 KB
- Stars: 105
- Watchers: 9
- Forks: 57
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Pulling from here:
```sh
~/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
```sh
~$ 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:
```sh
~/your-org.github.io$ make
```
5\. test it:
```sh
~/your-org.github.io$ firefox index.html
```
6\. add autogenerated files so they will appear on github pages:
```sh
~/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://.github.io`.
To do so, simply push your badgeboard to `https://github.com//.github.io`.
The second way is to deploy it to a URL like `https://.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//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.