RubyMine 2016.1 Help

Generating a Project from a Framework Template

On this page:

Overview

During project creation, RubyMine can generate a project stub for developing Web applications. The project structure is set up and some sources are generated based on external templates and frameworks downloaded upon your request.

RubyMine generates project stubs based on the following templates:

Generating a HTML5 Boilerplate, Web Starter Kit, React Starter Kit, Twitter Bootstrap, or Foundation Application Stub

  1. Choose File | New Project on the main menu or click the New Project button on the Welcome screen. The Create New Project: Select Project Type dialog box 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:
    • Empty: choose this option to get just a project folder without any contents.
    • HTML5 Boilerplate: choose 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: choose this option to use the Web Starter Kit.
    • React Starter Kit: choose this option to use the React Starter Kit.
    • Twitter Bootstrap: choose this option to use the Twitter Bootstrap template, which is an elaborate modular toolkit with rich HTML, CSS, and JavaScript support.
    • Foundation: choose this option to use the Foundation framework.
  3. The set of controls in the right-hand pane depends on the chosen template.
    1. In the Location text box, specify the path to the project folder where the project-related files will be stored.
    2. Choose the template version to use and click Create.

Generating a Node.js Express Application Stub

Generating such application stubs requires that Node.js is supported in RubyMine:

  1. The Node.js runtime environment is downloaded and installed on your computer.
  2. The Node.js repository plugin is installed and enabled. The plugin is not bundled with RubyMine, but it can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins.
Learn more in Node.js

To generate a Node.js application stub:

  1. Choose File | New Project on the main menu or click the New Project button on the Welcome screen. The Create New Project: Select Project Type dialog box opens.
  2. In the left-hand pane, choose Node.js Express App.
  3. In the right-hand pane, specify the following:
    1. In the Location text box, specify the path to the project folder where the project-related files will be stored.
    2. The path to the Node.js executable file node.exe and to the Node.js package manager file npm.cmd.
    3. The Express template engine to use. From the Template engine drop-down list, choose one of the following:
    4. The CSS engine to use. From the CSS engine drop-down list, choose one of the following:
  4. Click Create, when ready. RubyMine 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.

Generating a Dart Application Stub

Generating Dart application stubs requires that Dart is supported in RubyMine:

  1. The Dart SDK is available on your computer.
  2. The Dart plugin is installed and enabled. The plugin is not bundled with RubyMine, but it can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins.

To generate a Dart application stub:

  1. Choose File | New Project on the main menu or click the New Project button on the Welcome screen. The Create New Project: Select Project Type dialog box opens.
  2. In the left-hand pane, choose Dart.
  3. In the right-hand pane:
    1. In the Location text box, specify the path to the project folder where the project-related files will be stored.
    2. Specify the paths to the Dart SDK and to the Dartium executable file. RubyMine detects and displays the Dart version. If the SDK was downloaded within the Dart Editor Bundle, the path to Dartium is also detected and filled in automatically.
    3. To have annotations verified and assertions checked, select the Start Dartium in checked mode check box. Learn more about Dartium command line flags at https://www.dartlang.org/tools/dartium/.
    Click Create when ready.

If necessary, you can open the Dart page of the Settings dialog box by clicking the Settings button and configure command-line options and a custom user data directory for Dartium.

Generating a Meteor Application Stub

When you click Create, RubyMine generates a skeleton of a Meteor application, including an HTML file, a JavaScript file, a CSS file, and a .meteor folder with subfolders. The .meteor/local folder, which is intended for storing the built application, is automatically marked as excluded and is not involved in indexing.

By default, excluded files are shown in the project tree. To have the .meteor/local folder hidden, click the viewMode button on the toolbar of the Project tool window and remove a tick next to the Show Excluded Files option.

RubyMine also automatically attaches the predefined Meteor library to the project, thus enabling syntax highlighting, resolving references, and code completion. See Configuring JavaScript Libraries for details.

Meteor uses Spacebars templates that are an extension of the Handlebars/Mustache templates. RubyMine recognizes Spacebars templates, but as a side effect marks HTML files in Meteor projects with the Handlebars/Mustache icon fileTypeHandlebars.

  1. Choose File | New Project on the main menu or click the New Project button on the Welcome screen. The Create New Project: Select Project Type dialog box opens.
  2. In the left-hand pane, choose Meteor JS App.
  3. In the right-hand pane:
    1. In the Location text box, specify the path to the project 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 drop-down list, choose the sample to generate. To have a basic project structure generated, choose the Default option.
    4. In the Filename text box, type the name for the mutually related .js, .html, and .css files that will be generated. The text box is available only if the Default sample type is selected from the Template drop-dow list.

Generating a PhoneGap/Cordova/Ionic Application Stub

  1. Choose File | New Project on the main menu or click the New Project button on the Welcome screen. The Create New Project: Select Project Type dialog box opens.
  2. In the left-hand pane, choose PhoneGap/Cordova App.
  3. In the right-hand pane:
    1. In the Location text box, specify the path to the project folder where the project-related files will be stored.
    2. Specify the location of the executable file phonegap.cmd, or cordova.cmd, or ionic.cmd (see Installing PhoneGap/Cordova/Ionic).

When you click Create, RubyMine generates a skeleton of a PhoneGap/Cordova/Ionic application with the framework-specific structure.

Generating an AngularJS Application Stub

This requires that the AngularJS plugin is installed and enabled. The plugin is not bundled with RubyMine, but it can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins.

To generate an AngularJS application stub:

  1. Choose File | New Project on the main menu or click the New Project button on the Welcome screen. The Create New Project: Select Project Type dialog box opens.
  2. In the left-hand pane, choose AngularJS.
  3. In the right-hand pane:
    1. In the Location text box, specify the path to the project folder where the project-related files will be stored.
    2. From the Version drop-down list, choose the branch https://github.com/angular/angular.js to download the project template from. By default, master if shown.
  4. When you click Create, RubyMine sets up the AngularJS-specific project structure and generates the bower.json and package.json files with the definitions of all the necessary dependencies.
  5. Download the AngularJs dependencies that contain the AngularJS code and the tools that support development and testing.
    1. Launch the embedded Terminal by hovering your mouse pointer over show_tool_window_bars in the lower left corner of RubyMine and choosing Terminal from the menu (see Working with Embedded Local Terminal for details).
    2. Switch to the directory where NPM is stored or define a PATH variable for it so it is available from any folder, see Installing NodeJs.
    3. At the command line prompt, type the following command:
      npm install

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

When you click Create, RubyMine generates a skeleton of a AngularJS application with the framework-specific structure.

Generating a Composer Project Stub

You can have RubyMine generate a project stub from an existing package using Composer. In this case, Composer will be initialized and one package will be installed during the project stub creation. After that you can use Composer from the command line or through the user interface.
  1. Choose File | New Project on the main menu or click the New Project button on the Welcome screen. The Create New Project: Select Project Type dialog box opens.
    1. Appoint the Composer instance to use.
      • To use commands from a previously downloaded composer.phar, choose Use existing composer.phar: and specify it location in the text box.
      • To have a new instance of Composer downloaded, choose Download composer.phar from getcomposer.org:.
    2. In the Package area, specify the package to install during the project creation. Select the package to add from the Available Packages list, possibly using the search field, and choose the relevant version from the Version to install drop-down list.
    3. Expand the Settings area and specify the path to the PHP interpreter to use (see Configuring Remote Ruby Interpreters and Configuring Local Ruby Interpreters for details). In the Command line parameters text box, type the additional command line parameters to adjust the add dependency procedure. For example, to have a package added to the require-dev section instead of the default require section type -dev. For more information about Composer command line options during installation, see https://getcomposer.org/doc/03-cli.md.

When you click ok, the create-project command is invoked with the selected package. This results in creating a Composer project whose configuration and structure depends on the selected package, see https://getcomposer.org/doc/03-cli.md#create-project for details. After that a RubyMine project opens.

Generating a WordPress Application Stub

  1. Choose File | New Project on the main menu or click the New Project button on the Welcome screen. The Create New Project: Select Project Type dialog box opens.
  2. In the WordPress Installation Path text box, specify the folder where WordPress is installed. This folder should contain the wp-admin and wp-includes subdirectories. Click to start the project stub generation.
  3. If the newly created project is outside the WordPress installation folder, configure it as an external library by adding it to the list of included path.
    1. Open the Settings / Preferences Dialog by choosing File | Settings for Windows and Linux or RubyMine | Preferences for OS X, and click PHP under Languages&Frameworks.
    2. On the PHP page that opens, add the path to the WordPress installation folder to the Include Paths list: click the add button and specify the path to the installation folder in the dialog box that opens. Learn more in Configuring Include Paths.

Generating a Drupal Module Stub

  1. Choose File | New Project on the main menu or click the New Project button on the Welcome screen. The Create New Project: Select Project Type dialog box opens.
    1. Specify the root folder of the Drupal installation in the Drupal installation path. Type the path manually or click the Browse button browseButton and select the relevant folder in the dialog box that opens.
    2. Select the Set up PHP | Include paths check box to have Drupal include paths automatically configured for the project. The following paths will be added to the Include Paths list on the PHP page of the Settings dialog box:
      1. <drupal installation root>/includes
      2. <drupal installation root>/modules
      3. <drupal installation root>/sites/all/modules

      The include paths are added to the list after you leave the dialog box.

    3. From the Version drop-down list, choose the version of Drupal to use, the supported versions are 6, 7, and 8 .

You can update the Drupal integration settings at any time later in the Settings dialog box ( File | Settings ).

RubyMine generates a project stub in accordance with the selected Drupal version. For Drupal 8, a module_name.info.yml file is generated where information about the module is provided.

See Also

Last modified: 21 July 2016