0.1.0 • Published 9 years ago
bigdiff-code v0.1.0
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
$ nvm install
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 into a JSON file or DB.
queryResult
View, filter, and export queryResult.
- viewSummary
- filterBy
- export
searcher
Search things on github(remote) or git(local) by key
- searchCommitsByKeyword
- searchIssuesByKeyword
- searchSourceDiff
googlePlay
Search packages, crawl their information, and save them.
- isExisted: check a app whether existed or not in Google Play with package ID
- crawlInformation: crawl information of the app and save it into DB
utils
Some utils help other modules.
utils.dateRange
: generate date range between start and end date.
Testing
We use mocha and Should.js in order to be assured that our implementation of functions properly.
To run the tests for bigdiff-code simply run:
$ make test
Style guide
You will want to understand and follow the style guides listed below.
0.1.0
9 years ago