GitXplorerGitXplorer
s

RepoHunter-API

public
1 stars
0 forks
13 issues

Commits

List of commits on branch master.
Unverified
605a983404096e4a134cd73f11817eae83686047

Merge pull request #3 from squgeim/feature/RH-007

ssqugeim committed 7 years ago
Unverified
132ba3010cc03eab7b98693ed3f5b63b5edd2eb3

RH-007 -m Created API for retriving package informations -t 2 hrs -s Completed

committed 7 years ago
Unverified
05fc533e223b20219487ec0ea69ee450c9721998

Add package details from package.json

ssqugeim committed 8 years ago
Unverified
21b7a92b9b430395791e45a27821748f87e1daa1

Removed host from swagger config

ssqugeim committed 8 years ago
Unverified
6430e61df348dc0099533f823572bfbf465da608

Add API documentation

ssqugeim committed 8 years ago
Unverified
10c2aaf3daa66df67c21a151e2dd71d1b615bfb7

Update README.md

ssqugeim committed 8 years ago

README

The README file for this repository.

RepoHunter API

In any organization with freely working teams, there comes a time when nobody really knows what everyone else is working on. This is especially true in the case of javascript with the break-neck speed that the ecosystem is evolving in.

RepoHunter is a tool for your organization that lets you search who uses what in your organization.

APIs

You are starting a new project and are in a dilemma between bookshelf and sequelize for you ORM. You wanna check who uses what and get some first hand opinions:

GET /api/search/npm?q=bookshelf

For complete API documentation:

GET /api-docs

Deployment

You can replace yarn by npm in all of these commands, if you prefer to.

1. Clone this repo in your server.

git clone https://github.com/squgeim/RepoHunter-API

2. Install the dependencies

yarn install

3. Copy the .env.example file to .env file

cp .env.example .env

4. Set the appropriate environment settings in the .env file.

Enter your organization's github name in GITHUB_ORGANIZATION. Enter the admin's access token in GITHUB_TOKEN.

See here to know more about Personal Access Tokens in Github: https://github.com/blog/1509-personal-api-tokens

Make sure you have the repo scope activated for this access token.

5. Start the server

yarn start

For development server:

yarn start:dev

We have not included any process management tools like forever or pm2 here. Please feel free to use whatever you prefer if you need one.

Contribution

Feel free to fork this project. Do send a pull request our way if you implement something the world should see.