{"id":20551479,"url":"https://github.com/generate/generate-project","last_synced_at":"2025-07-29T02:35:14.920Z","repository":{"id":57246162,"uuid":"62818540","full_name":"generate/generate-project","owner":"generate","description":"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.","archived":false,"fork":false,"pushed_at":"2017-10-17T06:12:42.000Z","size":2041,"stargazers_count":11,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-13T02:03:07.777Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/generate.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-07-07T15:38:59.000Z","updated_at":"2022-09-13T09:22:51.000Z","dependencies_parsed_at":"2022-08-24T16:31:39.331Z","dependency_job_id":null,"html_url":"https://github.com/generate/generate-project","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-project","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-project/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-project/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-project/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/generate","download_url":"https://codeload.github.com/generate/generate-project/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248869543,"owners_count":21174896,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T02:31:24.919Z","updated_at":"2025-04-14T11:23:52.209Z","avatar_url":"https://github.com/generate.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\n\u003ca href=\"https://github.com/generate/generate\"\u003e\n\u003cimg height=\"150\" width=\"150\" src=\"https://raw.githubusercontent.com/generate/generate/master/docs/logo.png\"\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\nScaffold out complete code projects from the command line, or use this generator as a plugin in other generators to provide baseline functionality.\n\n# generate-project\n\n[![NPM version](https://img.shields.io/npm/v/generate-project.svg?style=flat)](https://www.npmjs.com/package/generate-project) [![NPM monthly downloads](https://img.shields.io/npm/dm/generate-project.svg?style=flat)](https://npmjs.org/package/generate-project) [![Build Status](https://img.shields.io/travis/generate/generate-project.svg?style=flat)](https://travis-ci.org/generate/generate-project)\n\n![generate-project demo](https://raw.githubusercontent.com/generate/generate-project/master/docs/demo.gif)\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eTable of Contents\u003c/strong\u003e\u003c/summary\u003e\n\n- [Getting started](#getting-started)\n  * [Install](#install)\n  * [CLI](#cli)\n  * [Help](#help)\n- [Next steps](#next-steps)\n  * [Running unit tests](#running-unit-tests)\n  * [Publishing your generator](#publishing-your-generator)\n- [About](#about)\n  * [What is \"Generate\"?](#what-is-generate)\n  * [Related projects](#related-projects)\n  * [Community](#community)\n  * [Contributing](#contributing)\n  * [Running tests](#running-tests)\n  * [Author](#author)\n  * [License](#license)\n\n_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_\n\n\u003c/details\u003e\n\n## Getting started\n\n### Install\n\n**Installing the CLI**\n\nTo 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:\n\n```sh\n$ npm install --global generate\n```\n\nThis adds the `gen` command to your system path, allowing it to be run from any directory.\n\n**Install generate-project**\n\nInstall this module with the following command:\n\n```sh\n$ npm install --global generate-project\n```\n\n### CLI\n\nRun this generator's `default` [task](https://github.com/generate/generate/blob/master/docs/tasks.md#default) with the following command:\n\n```sh\n$ gen project\n# or\n$ gen project:default\n```\n\n**What will happen?**\n\nRunning `$ gen project` will run this generator's [default task](#default), which will:\n\n1. prompt you for any information that's missing\n2. render templates using your answers\n3. generate [the resulting files](#generated-files) to the current working directory.\n\n**Conflict detection**\n\nIn 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_.\n\nYou 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.\n\n**What you should see in the terminal**\n\nIf completed successfully, you should see both `starting` and `finished` events in the terminal, like the following:\n\n```sh\n[00:44:21] starting ...\n...\n[00:44:22] finished ✔\n```\n\nIf you do not see one or both of those events, please [let us know about it](../../issues).\n\n### Help\n\nTo see a general help menu and available commands for Generate's CLI, run:\n\n```sh\n$ gen help\n```\n\n### Related projects\n\n* [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.\")\n* [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.\")\n* [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.\")\n\n### Community\n\nAre 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?\n\nHere are some suggestions!\n\n* If you get like Generate and want to tweet about it, please feel free to mention `@generatejs` or use the `#generatejs` hashtag\n* Show your love by starring [Generate](https://github.com/generate/generate) and `generate-project`\n* Get implementation help on [StackOverflow](http://stackoverflow.com/questions/tagged/generate) (please use the `generatejs` tag in questions)\n* **Gitter** Discuss Generate with us on [Gitter](https://gitter.im/generate/generate)\n* If you publish an generator, thank you! To make your project as discoverable as possible, please add the keyword `generategenerator` to package.json.\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\nPlease read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.\n\n### Running tests\n\nRunning 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:\n\n```sh\n$ npm install \u0026\u0026 npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on July 29, 2017._","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenerate%2Fgenerate-project","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgenerate%2Fgenerate-project","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenerate%2Fgenerate-project/lists"}