https://github.com/maxlath/backup-github-repo
Backup all the issues and pull requests of a Github repo, including the comments, events, and labels, as JSON and as HTML
https://github.com/maxlath/backup-github-repo
backup files github html issues json pr pull-requests
Last synced: 7 months ago
JSON representation
Backup all the issues and pull requests of a Github repo, including the comments, events, and labels, as JSON and as HTML
- Host: GitHub
- URL: https://github.com/maxlath/backup-github-repo
- Owner: maxlath
- Created: 2018-05-24T18:40:21.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-07-17T15:53:02.000Z (about 1 year ago)
- Last Synced: 2024-11-12T13:38:44.774Z (11 months ago)
- Topics: backup, files, github, html, issues, json, pr, pull-requests
- Language: JavaScript
- Homepage:
- Size: 792 KB
- Stars: 40
- Watchers: 3
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
- awesome-starred - maxlath/backup-github-repo - Backup all the issues and pull requests of a Github repo, including the comments, events, and labels, as JSON and as HTML (html)
README
# backup-github-repo
Backup all the issues and pull requests of a Github repo, including the comments, events, and labels, as JSON and as HTML.
[](https://npmjs.com/package/backup-github-repo/)
**Features**
* generate a JSON file with all the issues and pull requests, including comments ([demo](https://github.com/maxlath/backup-github-repo/blob/master/demo/data.json))
* generate one HTML file per issue or pull request ([demo](https://github.com/maxlath/backup-github-repo/tree/master/demo/html))
* download CSS files and images locally to allow offline browsing ([demo](https://github.com/maxlath/backup-github-repo/tree/master/demo/html/assets))
**Known limitations**
* **Private repos**: while JSON download works, the tool will fail to download HTML versions (see [issue](https://github.com/maxlath/backup-github-repo/issues/2))
## Dependencies
* [NodeJS](https://nodejs.org) >= 7.6
* [curl](https://curl.se/)
* [jq](https://stedolan.github.io/jq/)
## Install
```sh
npm install -g backup-github-repo
```
## Run
### Local repository
```sh
cd /path/to/my/repo/to/backup
# First run will give you instructions to set a Github API token
backup-github-repo
```
### Specify repository by URL
```sh
backup-github-repo https://github.com/maxlath/backup-github-repo
```
## License
MIT