https://github.com/generate/generate-project
Scaffold out complete code projects from the command line by installing this generator globally, or use this generator as a plugin in other generators to provide baseline functionality.
https://github.com/generate/generate-project
Last synced: 11 months ago
JSON representation
Scaffold out complete code projects from the command line by installing this generator globally, or use this generator as a plugin in other generators to provide baseline functionality.
- Host: GitHub
- URL: https://github.com/generate/generate-project
- Owner: generate
- License: mit
- Created: 2016-07-07T15:38:59.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-10-17T06:12:42.000Z (over 8 years ago)
- Last Synced: 2025-04-13T02:03:07.777Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 1.95 MB
- Stars: 11
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
Scaffold out complete code projects from the command line, or use this generator as a plugin in other generators to provide baseline functionality.
# generate-project
[](https://www.npmjs.com/package/generate-project) [](https://npmjs.org/package/generate-project) [](https://travis-ci.org/generate/generate-project)
Table of Contents
- [Getting started](#getting-started)
* [Install](#install)
* [CLI](#cli)
* [Help](#help)
- [Next steps](#next-steps)
* [Running unit tests](#running-unit-tests)
* [Publishing your generator](#publishing-your-generator)
- [About](#about)
* [What is "Generate"?](#what-is-generate)
* [Related projects](#related-projects)
* [Community](#community)
* [Contributing](#contributing)
* [Running tests](#running-tests)
* [Author](#author)
* [License](#license)
_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_
## Getting started
### Install
**Installing the CLI**
To run the `default` 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-project**
Install this module with the following command:
```sh
$ npm install --global generate-project
```
### CLI
Run this generator's `default` [task](https://github.com/generate/generate/blob/master/docs/tasks.md#default) with the following command:
```sh
$ gen project
# or
$ gen project:default
```
**What will happen?**
Running `$ gen project` will run this generator's [default task](#default), which will:
1. prompt you for any information that's missing
2. render templates using your answers
3. generate [the resulting files](#generated-files) to the current working directory.
**Conflict detection**
In the case that a file already exists on the file system, you will be [prompted for feedback](https://github.com/node-base/base-fs-conflicts) _before overwrite any files_.
You can [set the destination](https://github.com/generate/generate/blob/master/docs/customization.md) to a new directory if you want to avoid the prompts, or avoid accidentally overwriting files with unintentional answers.
**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
```
### Related projects
* [generate-dest](https://www.npmjs.com/package/generate-dest): Prompts the user for the destination directory to use. Can be used from the command… [more](https://github.com/generate/generate-dest) | [homepage](https://github.com/generate/generate-dest "Prompts the user for the destination directory to use. Can be used from the command line when installed globally, or as plugin or sub-generator in your generator.")
* [generate-install](https://www.npmjs.com/package/generate-install): Generator that automatically detects the dependencies or devDependencies to install based on the templates or… [more](https://github.com/generate/generate-install) | [homepage](https://github.com/generate/generate-install "Generator that automatically detects the dependencies or devDependencies to install based on the templates or includes that are dynamically used by your generator. This can be used as a sub-generator or plugin in your own generator.")
* [generate-package](https://www.npmjs.com/package/generate-package): Generate a package.json from a pre-defined or user-defined template. This generator can be used from… [more](https://github.com/generate/generate-package) | [homepage](https://github.com/generate/generate-package "Generate a package.json from a pre-defined or user-defined template. This generator can be used from the command line when globally installed, or as a plugin or sub-generator in your own generator.")
### 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-project`
* 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
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2017, [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 July 29, 2017._