https://github.com/octolinker/api
Registry proxy for OctoLinker
https://github.com/octolinker/api
hacktoberfest
Last synced: 11 months ago
JSON representation
Registry proxy for OctoLinker
- Host: GitHub
- URL: https://github.com/octolinker/api
- Owner: OctoLinker
- Created: 2015-08-18T21:00:10.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-01-15T12:52:07.000Z (almost 2 years ago)
- Last Synced: 2024-10-30T00:55:44.847Z (about 1 year ago)
- Topics: hacktoberfest
- Language: HTML
- Homepage: https://octolinker-api.now.sh
- Size: 3.7 MB
- Stars: 38
- Watchers: 9
- Forks: 11
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# OctoLinker API
Returns the github repository url for the requested package.
The supported registries are:
- [npmjs.com](https://npmjs.com)
- [bower.io](http:/bower.io)
- [getcomposer.org](https://getcomposer.org)
- [rubygems.org](https://rubygems.org)
- [pypi.python.org](https://pypi.python.org)
- [crates.io](https://crates.io)
- [melpa.org](https://melpa.org)
- [pub.dev](https://pub.dev)
- [nuget.org](https://www.nuget.org/)
Example:
[POST] https://octolinker-api.now.sh/
Body:
```json
[
{ "type": "npm", "target": "react" },
{ "type": "composer", "target": "phpunit/phpunit" },
{ "type": "ping", "target": "https://github.com" },
{ "type": "npm", "target": "unknown-package" }
]
```
or as
[GET] https://octolinker-api.now.sh/?npm=react,lodash&composer=phpunit/phpunit
Type must be one of:
- `npm`
- `bower`
- `composer`
- `rubygems`
- `pypi`
- `crates`
- `java`
- `go`
- `pub`
- `cran`
- `nuget`
- `ping`
Response:
```json
{
"result": [
{
"type": "npm",
"target": "react",
"result": "https://github.com/facebook/react"
},
{
"type": "composer",
"target": "phpunit/phpunit",
"result": "https://github.com/sebastianbergmann/phpunit"
},
{
"type": "ping",
"target": "https://github.com",
"result": "https://github.com"
},
{
"type": "npm",
"target": "unknown-package"
}
]
}
```
## Installation
Install dependencies:
`npm install`
Run server:
`npm run dev`
## Testing
`npm test`
## Privacy Policy
Our [Privacy Policy](https://octolinker.now.sh/privacy/) describes our practices related to the use, storage and disclosure of information we collect when you're using our service.
## License
Copyright (c) 2015–present [Stefan Buck](https://stefanbuck.com/) and [other contributors](https://github.com/OctoLinker/api/graphs/contributors).
Licensed under the MIT license.