Code Monkey home page Code Monkey logo

bigdiff-code's Introduction

bigdiff-code

You can find what we need to do in issue.

Setup

To setup the environment, run:

$ git clone https://github.com/sangheestyle/bigdiff-code
$ cd bigdiff-code
$ npm install

For more information, please see documentation for bigdiff-code

How to use

You can see some example to know how to use this module.

Submodules and functionalities

The bigdiff-code module will give you submodules for accessing repositories and social artifacts.

git

Wrap git functionalities.

  • git.log: do git log with given regular expression.
  • git.grep: grep commits by given regular expression and context.
  • git.clone: clone single repository.
  • git.multipleClone: clone single or multiple repositories.

github

Find repositories or issues via various criteria. See Search APIs.

  • github.authClient: return a client with authentification.
  • github.getRepoIssues: get issues of a repository and save result in DB.
  • github.searchRepos: search repos and save result in DB.

googlePlay

Search packages, crawl their information, and save them.

  • getReviews: crawl reviews of app.
  • isExisted: check a app whether existed or not in Google Play with package ID.

utils

Some utils help other modules.

  • utils.dateRange: generate date range between start and end date.

REST APIs

POST api/search/commits

Search regex for commits with some params. example

$ curl -H "Content-Type: application/json" -X POST \
-d '{"regex": ".setTag\\([^,|^\\(]*,[^,]*\\)", "ext":"java", "local_repo_root": "demo_set", "max":100}' \
http://sangheestyle.com:8080/api/search/commits \
-o result.json

Params:

  • regex: regular expression
  • ext: file extension
  • local_repo_root: root directory including cloned repos
    • repos: root including all the cloned repos
    • demo_set: root incuding only some cloned repos
  • max: max number of result to get limited result

Style guide

You will want to understand and follow the style guides listed below.

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.