https://github.com/jonschlinkert/get-repository-url
Get the GitHub repository URL from a NPM package name.
https://github.com/jonschlinkert/get-repository-url
github npm project repo repository url
Last synced: about 1 year ago
JSON representation
Get the GitHub repository URL from a NPM package name.
- Host: GitHub
- URL: https://github.com/jonschlinkert/get-repository-url
- Owner: jonschlinkert
- License: mit
- Created: 2016-07-12T23:41:54.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-05-28T19:38:58.000Z (about 8 years ago)
- Last Synced: 2025-04-27T15:06:43.268Z (about 1 year ago)
- Topics: github, npm, project, repo, repository, url
- Language: JavaScript
- Size: 15.6 KB
- Stars: 21
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# get-repository-url [](https://www.npmjs.com/package/get-repository-url) [](https://npmjs.org/package/get-repository-url) [](https://npmjs.org/package/get-repository-url) [](https://travis-ci.org/jonschlinkert/get-repository-url)
> Get the GitHub repository URL from a NPM package name.
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save get-repository-url
```
## Usage
```js
const repoUrl = require('get-repository-url');
// takes a callback
repoUrl('generate', function(err, url) {
console.log(url);
//=> 'https://github.com/generate/generate'
});
// or returns a promise
repoUrl('generate')
.then(function(url) {
console.log(url);
//=> 'https://github.com/generate/generate'
});
```
## About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Related projects
You might also be interested in these projects:
* [get-pkg](https://www.npmjs.com/package/get-pkg): Get the package.json for a project from npm. | [homepage](https://github.com/jonschlinkert/get-pkg "Get the package.json for a project from npm.")
* [get-pkgs](https://www.npmjs.com/package/get-pkgs): Get the package.json for an array of repos from the npm registry, optionally filtering properties… [more](https://github.com/jonschlinkert/get-pkgs) | [homepage](https://github.com/jonschlinkert/get-pkgs "Get the package.json for an array of repos from the npm registry, optionally filtering properties using glob patterns.")
* [github-base](https://www.npmjs.com/package/github-base): JavaScript wrapper that greatly simplifies working with GitHub's API. | [homepage](https://github.com/jonschlinkert/github-base "JavaScript wrapper that greatly simplifies working with GitHub's API.")
### Contributors
| **Commits** | **Contributor** |
| --- | --- |
| 14 | [jonschlinkert](https://github.com/jonschlinkert) |
| 2 | [mootari](https://github.com/mootari) |
### Author
**Jon Schlinkert**
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)
### License
Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on May 28, 2018._