Skip to content

Latest commit

 

History

History
179 lines (109 loc) · 5.46 KB

README.md

File metadata and controls

179 lines (109 loc) · 5.46 KB
Raw

Generate generator for creating React applications, components, and related React resources.

@generate/react

NPM version NPM monthly downloads

@generate/react demo

Work in progress

This generator is still a work in progress and will be published soon.

Getting started

Install

Installing the CLI

To run the @generate/react 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/react

Install this module with the following command:

$ npm install --global @generate/react

CLI

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

$ gen @generate/react

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 's CLI, run:

$  help

Available tasks

All available tasks for this generator.

react:react

Generate a index.js file to the current working directory. Learn how to [customize behavior(#customization) or override built-in templates.

Example

$ gen react:react

react

Alias for running the react task with the following command:

Example

$ gen react

Visit Generate's documentation for tasks.

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:

$ npm install && test

Publishing your generator

If you're tests are passing and you're ready to publish your generator to npm, you can do that now with the following command:

Are you sure you're ready?!

Let's go!

$ npm publish

About

What is "Generate"?

Generate is a command line tool and developer framework for scaffolding out new GitHub projects using generators and tasks.

Answers to prompts and the user's environment can be used to determine the templates, directories, files and contents to build. Support for gulp, base and assemble plugins, and much more.

For more information:

Community

Bigger community means more plugins, better support and more progress. Help us make Generate better by spreading the word:

  • Show your love by starring the project
  • Tweet about Generate. Mention using @generatejs, or use the #generatejs hashtag
  • Get implementation help on StackOverflow with the generatejs tag
  • Discuss Generate with us on Gitter
  • If you publish a generator, to make your project as discoverable as possible, please add the unique keyword generategenerator to your project's package.json.

Contributors

Commits Contributor
565 jonschlinkert
27 doowb
1 dawsbot
1 stefanwalther

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

Yash Pandit

License

Copyright © 2020, Yash Pandit. Released under the MIT License.

This file was generated by verb-generate-readme, v0.8.0, on January 10, 2020.