# githubstarredrepobackup

**Repository Path**: 8ox86/githubstarredrepobackup

## Basic Information

- **Project Name**: githubstarredrepobackup
- **Description**: simple tool to export github starred repos to mongodb via public api

 the api doc can be found at https://developer.github.com/v3/activity/starring/#list-repositories-being-starred
- **Primary Language**: Go
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2018-07-19
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#githubStarredRepoBackup

1. How to build
clone this repo and go to the repo dir.
run 
```bash
go build .
```

2. Configuration

firt ,make a copy of config.sample.ini :
```bash
cp ./config.sample.ini config.ini
```

then edit config.ini use your favorite editor.

sample config:
```ini
[github]
#the github account (which suspended by github is also OK) need to backup
user = ihacklog
start_page = 1
per_page = 100
sleep = 800
#the oauth token of your new github account
# get token from https://github.com/settings/tokens/new
token = 
# set it to false if you also want to save star info to mongodb
star_only = true

#mongodb info is only required when star_only = false
[mongo]
user = huangyewudeng
passwd = passw0rd
host = 127.0.0.1
port = 27017
db_name = github
collection = starred
```

3. run it

```bash
./githubStarredRepoBackup
```