Skip to content

kshvmdn/discover

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

73 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

discover

Discover new GitHub repositories.

Enter a repository and aggregate a list of similar repositories.

Setup

Requirements:

  • Python 3+
  • Redis
  • Node.js (for development)

Installation

  • Clone project.

    git clone https://git@github.com/kshvmdn/explore-github.git
    cd explore-github
  • Install dependencies.

    pip install -r ./server/requirements.txt
    cd app && npm install && cd ..

Usage

  • You'll need to be running the server, front-end application, and Redis separately. I recommend tmux / iTerm 2, but multiple terminal windows will work just as well.

  • Generate a new access token here, you'll require this to run the server.

  • Start Redis.

    $ redis-server # add --daemonize yes to run Redis in the background
  • Start the Flask server. It'll be running on port 3001. See this for the API reference.

    $ ACCESS_TOKEN=<access_token> DEBUG=<True|False> ./server/app.py
  • Start the React application. It'll be running on port 3000.

    $ cd app && npm start

API

  • /api/1.0/{owner}/{repo}
    • Return a list of repositories starred by stargazers of the repository provided. Will return a maximum of 200 stargazers by 100 repositories (i.e. 20k repos).

Contribute

This project is completely open source. Feel free to open an issue for bugs/requests or submit a pull request for code contributions.

License

MIT © Kashav Madan.

About

Discover new GitHub repositories.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published