Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/generate/generate-gh-repo
Generate generator to create a new repository on GitHub.
https://github.com/generate/generate-gh-repo
create generate generator github init project scaffold scaffolding
Last synced: about 1 month ago
JSON representation
Generate generator to create a new repository on GitHub.
- Host: GitHub
- URL: https://github.com/generate/generate-gh-repo
- Owner: generate
- License: mit
- Created: 2017-01-25T04:00:09.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-05-07T11:16:32.000Z (over 7 years ago)
- Last Synced: 2024-11-06T16:16:41.167Z (about 2 months ago)
- Topics: create, generate, generator, github, init, project, scaffold, scaffolding
- Language: JavaScript
- Homepage: https://github.com/generate/generate-gh-repo
- Size: 2.31 MB
- Stars: 12
- Watchers: 3
- Forks: 3
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
Generate generator to create a new repository on GitHub.
# generate-gh-repo
[](https://www.npmjs.com/package/generate-gh-repo) [](https://npmjs.org/package/generate-gh-repo) [](https://travis-ci.org/generate/generate-gh-repo)
## Usage
### CLI
When installed globally, the `gh-repo` generator is available to use through the `gen` command:
Create a new GitHub repository using the [default](#default) task.
```sh
$ gen gh-repo
```
### API
**Params**
* `app` **{Object}**: [generate](https://github.com/generate/generate) instance to add tasks to.
**Example**
```js
// use as a plugin with existing generate instance
// $ gen gh-repo
app.use(require('generate-gh-repo'));
// use as a subgenerator on an existing generate instance
// $ gen repo
app.register('repo', require('generate-gh-repo'));
```
## Getting started
### Install
**Installing the CLI**
To run the `gh-repo` generator from the command line, you'll need to install [Generate](https://github.com/generate/generate) globally first. You can do that now with the following command:
```sh
$ npm install --global generate
```
This adds the `gen` command to your system path, allowing it to be run from any directory.
**Install generate-gh-repo**
Install this module with the following command:
```sh
$ npm install --global generate-gh-repo
```
### CLI
Run this generator's `default` [task](https://github.com/generate/generate/blob/master/docs/tasks.md#default) with the following command:
```sh
$ gen gh-repo
```
**What you should see in the terminal**
If completed successfully, you should see both `starting` and `finished` events in the terminal, like the following:
```sh
[00:44:21] starting ...
...
[00:44:22] finished ✔
```
If you do not see one or both of those events, please [let us know about it](../../issues).
### Help
To see a general help menu and available commands for Generate's CLI, run:
```sh
$ gen help
```
## Next steps
### Running unit tests
It's never too early to begin running unit tests. When you're ready to get started, the following command will ensure the project's dependencies are installed then run all of the unit tests:
```sh
$ npm install && test
```
### Publishing your generator
If you're tests are passing and you're ready to publish your generator to [npm](https://www.npmjs.com), you can do that now with the following command:
**Are you sure you're ready?!**
Let's go!
```sh
$ npm publish
```
## About
### What is "Generate"?
Generate is a command line tool and developer framework for scaffolding out new GitHub projects using [generators](https://github.com/generate/generate/blob/master/docs/generators.md) and [tasks](https://github.com/generate/generate/blob/master/docs/tasks.md).
Answers to prompts and the user's environment can be used to determine the templates, directories, files and contents to build. Support for [gulp](http://gulpjs.com), [base](https://github.com/node-base/base) and [assemble](https://github.com/assemble/assemble) plugins, and much more.
**For more information**:
* Visit the [generate project](https://github.com/generate/generate/)
* Visit the [generate documentation](https://github.com/generate/generate/blob/master/docs/)
* Find [generators on npm](https://www.npmjs.com/browse/keyword/generate-generator) (help us [author generators](https://github.com/generate/generate/blob/master/docs/micro-generators.md))
### Community
Are you using [Generate](https://github.com/generate/generate) in your project? Have you published a [generator](https://github.com/generate/generate/blob/master/docs/generators.md) and want to share your project with the world?
Here are some suggestions!
* If you get like Generate and want to tweet about it, please feel free to mention `@generatejs` or use the `#generatejs` hashtag
* Show your love by starring [Generate](https://github.com/generate/generate) and `generate-gh-repo`
* Get implementation help on [StackOverflow](http://stackoverflow.com/questions/tagged/generate) (please use the `generatejs` tag in questions)
* **Gitter** Discuss Generate with us on [Gitter](https://gitter.im/generate/generate)
* If you publish an generator, thank you! To make your project as discoverable as possible, please add the keyword `generategenerator` to package.json.
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Please read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.
### 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
```
### Author
**Brian Woodward**
* [github/doowb](https://github.com/doowb)
* [twitter/doowb](https://twitter.com/doowb)
### License
Copyright © 2017, [Brian Woodward](https://github.com/doowb).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.3, on April 07, 2017._