gorse-io / gitrec

A recommender system for GitHub repositories based on Gorse

GitRec

GitRec is the missing recommender system for GitHub repositories based on Gorse.

Browser Extensions

The browser extension integrates GitHub with GitRec.

1. Recommends repositories to GitHub users based on starred repositories.
2. Finds related repositories for popular repositories.

Quick Start

• First, clone the repository and enter the folder.

git clone https://github.com/zhenghaoz/gitrec.git
cd gitrec

• Create a .env file.

# Gorse secrets
GORSE_DASHBOARD_USER_NAME=********
GORSE_DASHBOARD_PASSWORD=********
GORSE_API_KEY=********

# GitHub secrets
GITHUB_ACCESS_TOKEN=********
GITHUB_OAUTH_CLIENT_ID=********
GITHUB_OAUTH_CLIENT_SECRET=********

# GitRec secrets
SECRET_KEY=********

# S3 secrets for backup
S3_ACCESS_KEY=********
S3_SECRET_KEY=********
S3_BUCKET_LOCATION=US
S3_HOST_BASE=s3.amazonaws.com
S3_HOST_BUCKET=%(bucket)s.s3.amazonaws.com

• Generate a personal access token from GitHub and fill the GITHUB_ACCESS_TOKEN variable in the .env file.

GITHUB_ACCESS_TOKEN=xxxxxxxx # personal access token

• Create a GitHub OAuth app. The authorization callback URL should be http://127.0.0.1:5000/login/github/authorized. Then, fill following variables in the .env file.

GITHUB_OAUTH_CLIENT_ID=xxxxxxxx     # client ID
GITHUB_OAUTH_CLIENT_SECRET=xxxxxxxx # client secret
SECRET_KEY=xxxxxxxx                 # random string

• Start the cluster using Docker Compose.

docker-compose up -d

• Download the SQL file github.sql and import it to the MySQL instance.

mysql -h 127.0.0.1 -u gorse -pgorse_pass gorse < github.sql

• Restart the master node to apply imported data.

docker-compose restart

• Play with GitRec:

Entry	Link
GitRec	http://127.0.0.1:5000/
Grafana Dashboard	http://127.0.0.1:3000/
Master Dashboard	http://127.0.0.1:8088/

Acknowledgments

• Thanks @lisonge for the Tampermonkey userscript.

gitrec's Issues

add shortcuts

add shortcuts for next, favourite and star operation.

[功能请求] 可否直接提供油猴脚本-已迁移完毕

迁移之后的脚本 https://github.com/lisonge/userscripts/tree/main/packages/gitrec

迁移之后基于 vite + vite-plugin-monkey + ts 编写

如果接受，能否发起 pull requests ？或者直接复制进去也行

希望可以增加每日目录，在浏览时能够更有方向感，不然会觉得很迷茫

Internal Server Error after Login

Hi,
Great project! For some reason, after I login with GitHub, there's an internal server error.

有没有去重

有没有去重

关于启动

请问老师 我按照文档 去安装启动（docker-compose），但是master启动error，请问是什么原因呢？config.toml这个文件是可以直接使用github上给的，还是需要修改里面的内容呢？

Can't download github.sql from https://cdn.gorse.io/example/github.sql

Does anyone have github.sql file? the link seems dead and I've been retry it every single day but I think it won't be fixed in a while

负样本从哪里来？

我看了源码，没有太明白，我们爬stared 的项目， "FeedbackType": "star", 都是正样本；负样本从哪里来？

live demo on gorse.io seems dead

shows white screen. no content.

#19 9.900 ERROR: Could not install packages due to an OSError: HTTPSConnectionPool(host='files.pythonhosted.org', port=443): Max retries exceeded with url: /packages/80/f1/cd7626c763e58f967317023c3dd01a2fab5d6f00f8e1c672ccceb3aae5cb/amqp-5.0.6-py3-none-any.whl (Caused by SSLError(SSLCertVerificationError(1, '[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: self signed certificate in certificate chain (_ssl.c:1129)')))

#19 9.900 ERROR: Could not install packages due to an OSError: HTTPSConnectionPool(host='files.pythonhosted.org', port=443): Max retries exceeded with url: /packages/80/f1/cd7626c763e58f967317023c3dd01a2fab5d6f00f8e1c672ccceb3aae5cb/amqp-5.0.6-py3-none-any.whl (Caused by SSLError(SSLCertVerificationError(1, '[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: self signed certificate in certificate chain (_ssl.c:1129)')))

The frontend is stuck on loading

Hi, first thank you for sharing this project.

I followed the instructions on readme, but the apps seems to stuck on the loading page.

The master node seems to be working. I can visit the gorse dashboard. The user count shows 1, and other metrics all 0.

What shall I do?

File "github.sql" not found

Hi,
This necessary file to run the demo gitrec app is not available
in this URL :
https://cdn.gorse.io/example/github.sql
Can we download this file otherwise?
Thanks