README.md

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

Table of Contents

• Getting started
  • Install
  • CLI
  • Help
• Next steps
  • Running unit tests
  • Publishing your generator
• About
  • What is "Generate"?
  • Related projects
  • Community
  • Contributing
  • Running tests
  • Author
  • License

(TOC generated by verb using markdown-toc)

Getting started

Install

Installing the CLI

To run the default generator from the command line, you'll need to install Generate globally first. You can do that now with the following command:

$ 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:

$ npm install --global generate-project

CLI

Run this generator's default task with the following command:

$ gen project
# or
$ gen project:default

What will happen?

Running $ gen project will run this generator's default task, which will:

1. prompt you for any information that's missing
2. render templates using your answers
3. generate the resulting 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 before overwrite any files.

You can set the destination 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:

[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.

Help

To see a general help menu and available commands for Generate's CLI, run:

$ gen help

Related projects

• generate-dest: Prompts the user for the destination directory to use. Can be used from the command… more | homepage
• generate-install: Generator that automatically detects the dependencies or devDependencies to install based on the templates or… more | homepage
• generate-package: Generate a package.json from a pre-defined or user-defined template. This generator can be used from… more | homepage

Community

Are you using Generate in your project? Have you published a generator 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 and generate-project
• Get implementation help on StackOverflow (please use the generatejs tag in questions)
• Gitter Discuss Generate with us on Gitter
• 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.

Please read the contributing guide 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:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.6.0, on July 29, 2017.