Git Product home page Git Product logo

gitrec's Introduction

GitRec

test Website Discord Twitter Follow

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

Browser Extensions

Chrome Web Store Chrome Web Store Chrome Web Store Mozilla Add-on Mozilla Add-on Mozilla Add-on

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.