WebStorm 9.0.2 Web Help

Project

On this page:

Basics

Whatever you do in WebStorm, you do that in the context of a project. A project is an organizational unit that represents a complete software solution.

WebStorm does not support direct editing of files on remote hosts. Therefore to work with remote sources in WebStorm, you need to download them and arrange them in a WebStorm project. To keep your local and remote sources synchronized, configure automatic upload using the Upload changed files automatically to the default server drop-down list in the Options dialog box.

Project files

A project in WebStorm is represented in the Directory Based Format. A project directory is marked with icon_web_storm.png icon.

Such project directory contains a .idea directory, with the following files:

  • *.iml file that describes the project structure.
  • workspace.xml that contains your workspace preferences.
  • A number of .xml files. Each .xml file is responsible for its own set of settings, that can be recognized by its name: projectCodeStyle.xml, encodings.xml, vcs.xml etc.

    Thus, for example, adding a new run/debug configuration and changing encoding will affect different .xml files. This helps avoid merge conflicts when the project settings are stored in a version control system and modified by the different team members.

All the settings files in the .idea directory should be put under version control except the workspace.xml, which stores your local preferences. The workspace.xml file should be marked as ignored by VCS.

.idea directory is not visible in the Project view.

Project types

The directory structure of each project contains the .idea directory for the WebStorm-specific settings and the project file, and libraries.

WebStorm suggests the following types of projects:

  • Empty project is intended for pure language programming. The directory structure of such project contains the .idea directory for the WebStorm-specific settings and the project file, and libraries.

    Create a plain project as described in the section Creating New Project from Scratch.

  • Template-based projects are intended for developing web applications using third-party frameworks. WebStorm creates specific infrastructure, with the files and directories structured in accordance with the requirements of the selected framework.

Complete project creation as described in the section Generating a Project from a Framework Template.

See Also

Last modified: 11 December 2014
comments powered by Disqus