PyCharm 2022.2 Help

Generating a Project from a Framework Template

PyCharm can create new framework-specific applications for you, set up their structure, and download the required packages, if necessary. You can also use the Yeoman generator, see Yeoman for details.

AngularJS application

Before you start:

  1. Click Create New Project on the Welcome screen or select File | New | Project from the main menu. The New Project dialog opens.

  2. In the left-hand pane, choose AngularJS.

  3. In the right-hand pane, specify the path to the folder where the project-related files will be stored.

  4. When you click Create, PyCharm generates the AngularJS-specific project structure with all the required configuration files based on the AngularJS seed project

  5. Download the AngularJS dependencies that contain the AngularJS code and the tools that support development and testing: in the embedded Terminal (Alt+F12) , type:

    npm install

    Learn more about installing dependencies in the Install Dependencies section of the readme.md file.

HTML5 Boilerplate, Web Starter Kit, Bootstrap, or Foundation application

  1. Click Create New Project on the Welcome screen or select File | New | Project from the main menu. The New Project dialog opens.

  2. In the left-hand pane, choose the template to use depending on your preferences and the functionality to be implemented in your application:

    • HTML5 Boilerplate: select this option to use the HTML5 Boilerplate template. This is a starting project template that can be easily adapted to your needs.

    • Web Starter Kit: select this option to use the Web Starter Kit.

    • Bootstrap: select this option to use the Bootstrap template, which is an elaborate modular toolkit with rich HTML, CSS, and JavaScript support.

    • Foundation: select this option to use the Foundation framework.

  3. The set of controls in the right-hand pane depends on the chosen template.

    1. Specify the path to the folder where the project-related files will be stored.

    2. From the Version list, choose the template version to use and click Create.

Express application

Before you start:

  1. Install Node.js and configure it as a local Node.js interpreter.

  2. Make sure the Node.js plugin is enabled in the settings. Press Ctrl+Alt+S to open the IDE settings and select Plugins. Click the Installed tab. In the search field, type Node.js. For more details about plugins, see Managing plugins.

To generate a Node.js application

  1. Click Create New Project on the Welcome screen or select File | New | Project from the main menu. The New Project dialog opens.

  2. In the left-hand pane, choose Express.

  3. In the right-hand pane:

    1. Specify the path to the folder where the project-related files will be stored.

    2. The Node interpreter, see Configuring a local Node.js interpreter.

    3. The package manager to use - npm or Yarn, see npm, pnpm, and Yarn.

    4. The express -generator.

      It is recommended that you use npx that downloads and runs the generator. To do that, select npx --package express-generator express from the express -generator list.

      Alternatively, open the embedded Terminal (Alt+F12) and type npm install --g express-generator and then select the downloaded generator from the express-generator list.

    5. The Express template engine to use. From the Template engine list, choose one of the following:

    6. The CSS engine to use. From the CSS engine list, choose one of the following:

  4. Click Create, when ready.

    PyCharm launches the Express Project Generator tool that downloads all the required data, sets up the project structure, and opens the project either in the current window or in a new one, depending on your choice.

Meteor application

  1. Click Create New Project on the Welcome screen or select File | New | Project from the main menu. The New Project dialog opens.

  2. In the left-hand pane, choose Meteor.

  3. In the right-hand pane:

    1. Specify the path to the folder where the project-related files will be stored.

    2. Specify the location of the Meteor executable file (see Installing Meteor).

    3. From the Template list, choose the sample to generate. To have a basic project structure generated, choose the Default option.

    4. In the Filename field, type the name for the mutually related .js, .html, and .css files that will be generated. The field is available only if the Default sample type is selected from the Template drop-dow list.

  4. When you click Create, PyCharm generates a skeleton of a Meteor application, including an HTML file, a JavaScript file, a CSS file, and a .meteor folder with subfolders. PyCharm automatically marks the .meteor/local folder, which is intended for storing the built application, as excluded but still shows it in the project tree.

    By default, excluded files are shown in the project tree. To hide the .meteor/local folder, click Show Options Menu on the toolbar of the Project tool window, select Tree Appearance, and remove a tick next to the Show Excluded Files option.

PhoneGap or Cordova application

  1. Click Create New Project on the Welcome screen or select File | New | Project from the main menu. The New Project dialog opens.

  2. In the left-hand pane, choose Cordova.

  3. In the right-hand pane:

    1. Specify the path to the folder where the project-related files will be stored.

    2. Specify the location of the executable file. Depending on your operating system and target platform, this can be phonegap, phonegap.cmd, cordova, or cordova.cmd.

  4. When you click Create, PyCharm generates a skeleton of a PhoneGap or Cordova application with the framework-specific structure.

React application with create-react-app

  1. Click Create New Project on the Welcome screen or select File | New | Project from the main menu. The New Project dialog opens.

  2. In the left-hand pane, choose React.

  3. In the right-hand pane, specify the project folder, the Node.js interpreter to use, and the path to the create-react-app package.

  4. Optionally:

    To use TSX instead of JSX, select the Create TypeScript project checkbox. PyCharm will generate .tsx files for your application and a tsconfig.json configuration file.

  5. When you click Create, PyCharm generates a React-specific project with all the required configuration files.

Vue.js application with @vue/cli

  1. Click Create New Project on the Welcome screen or select File | New | Project from the main menu. The New Project dialog opens.

  2. In the left-hand pane, choose Vue.js.

  3. In the right-hand pane:

    1. Specify the path to the folder where the project-related files will be stored.

    2. In the Node Interpreter field, specify the Node.js interpreter to use. Select a configured interpreter from the list or choose Add to configure a new one.

    3. From the Vue CLI list, select npx --package @vue/cli vue.

      Alternatively, for npm version 5.1 and earlier, install the @vue/cli package yourself by running npm install --g @vue/cli in the Terminal Alt+F12. When creating an application, select the folder where the @vue/cli package is stored.

    4. From the Project template list, choose the Vue.js template to use.

  4. When you click Create, PyCharm asks you some additional questions about tools, like linters and the test runner, that can be added to the project. These questions vary depending on the template you've selected. After that, PyCharm generates a Vue.js-specific project with all the required configuration files.

Last modified: 24 August 2022