PyCharm 2018.1 Help

Creating a Project Using Yeoman Generator

PyCharm supports integration with the Yeoman tool and provides interface for using it in generating framework-specific project stubs.

Before you start

  1. Install Node.js and configure it as a local Node.js interpreter.
  2. Install and enable the Yeoman and the NodeJS repository plugins on the Plugins page as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins.

Installing and configuring Yeoman in PyCharm

  1. Open the embedded Terminal (View | Tool Windows | Terminal) and type npm install -g yo at the command prompt.
  2. In the Settings/Preferences dialog (Ctrl+Alt+S), click JavaScript under Languages and Frameworks, and then click Yeoman. On the Yeoman page that opens:
    1. Choose the Node.js interpreter to use, see Configuring a local Node.js interpreter for details.
    2. In the Yeoman yo package field, specify the location of the globally installed yo package.

Configuring a list of project stub generators

  1. Choose File | New | Project on the main menu or click Create New Project on the Welcome screen. The New Project dialog box opens.
  2. In the left-hand pane, choose Yeoman.
  3. The right-hand pane shows all the previously installed Yeoman generators. Click Install Generator.
  4. From the dialog box that opens showing all the available generator packages, select the required package in the left-hand pane and click the Install Generator button that appears in the right-hand pane. You can install several packages one after another without leaving the dialog box.

    When the installation is over, click Close to return to the list of generators which is already expanded with the newly added package.

Creating a project by a generator

  1. Choose File | New | Project on the main menu or click Create New Project on the Welcome screen. The New Project dialog box opens.
  2. In the left-hand pane, choose Yeoman.
  3. The right-hand pane shows all the previously installed Yeoman generators. To expand the list, click Install Generator, see Creating a Project Using Yeoman Generator above.

    Select the required generator from the list and click Next.

  4. Specify the required settings in the New Project wizard that starts. The number of pages and their contents depend on the chosen generator.
  5. On the last page of the wizard, select or clear the Run npm install&bower install checkbox to specify whether you want to run Node Package Manager and Bower to install the packages that are required for developing the new project.
  6. Click Next and choose to open the new project in the current window or in the new one.
Last modified: 27 June 2018

See Also