--- title: Creating a Project in IntelliJ order: 120 layout: page --- [[getting-started.idea]] = Creating a Project with IntelliJ IDEA The Ultimate Edition of IntelliJ IDEA includes support for creating Vaadin applications and running or debugging them in an integrated application server. With the Community Edition, you can create a Vaadin application most easily with a Maven archetype and deploy it to a server with a Maven run/debug configuration. ifdef::web[] For more information, see the article " link:http://wiki.jetbrains.net/intellij/Creating_a_simple_Web_application_and_deploying_it_to_Tomcat[Creating a simple Web application and deploying it to Tomcat]" in the IntelliJ IDEA Encyclopedia wiki. endif::web[] [[getting-started.idea.project]] == Creating a Vaadin Web Application Project In the welcome page, do the following: . Download and extract the Vaadin installation package to a local folder, as instructed in <>. . Select [menuchoice]#New Project# . In the [guilabel]#New Project# window, select [menuchoice]#Java# . Enter a [guilabel]#Project name# and [guilabel]#Project location#, and select the [guilabel]#Java SDK# to be used for the project. Vaadin requires at least Java 6. If you have not configured a Java SDK previously, you can configure it here. + image::img/idea-newproject-1.png[scaledwidth=100%] + Click [guibutton]#Next#. . Select "Web Application > Vaadin" to add Vaadin technology to the project. . Select Vaadin [guilabel]#Version# and [guilabel]#Distribution# installation path. You probably also want an application stub, so select [guilabel]#Create sample application# and give a name for the generated UI class. + image::img/idea-newproject-2.png[scaledwidth=100%] + Do __not__ click [guibutton]#Finish# yet. . Select [guilabel]#Application Server# in the same window. Set it as an integrated server that you have configured in IntelliJ IDEA, as described previously in <>. ifdef::web[] + image::img/idea-newproject-3.png[scaledwidth=100%] endif::web[] . Click [guibutton]#Finish#. The project is created with the UI class stub and a [filename]#web.xml# deployment descriptor. image::img/idea-newproject-4.png[scaledwidth=100%] The wizard does not currently create a servlet class automatically, and uses Servlet 2.4 compatible deployment with a [filename]#web.xml# deployment descriptor. [[getting-started.idea.project.running]] === Deploying the Project To deploy the application to the integrated web server, right-click the [filename]#index.jsp# file in the project and select [menuchoice]#Run 'index.jsp'#. This starts the integrated server, if it was not already running, and launches the default browser with the application page. [[getting-started.idea.maven]] == Creating a Maven Project You can choose to create a Maven project in IntelliJ IDEA. This is the recommended way when using the Community Edition. You will not have the application server integration, but can deploy the application to an application server using a run/debug configuration. . Select [menuchoice]#New Project# . In the [guilabel]#New Project# window, select [menuchoice]#Maven# //<?dbfo-need height="8cm" ?> . Enter a project name, location, and the Java SDK to be used for the project. Vaadin requires at least Java 6. + image::img/idea-maven-newproject-1.png[scaledwidth=100%] + Click [guibutton]#Next#. //<?dbfo-need height="6cm" ?> . Give a Maven [guilabel]#GroupID#, [guilabel]#ArtifactID#, and a [guilabel]#Version# for the project, or use the defaults. + image::img/idea-maven-newproject-2.png[scaledwidth=100%] . Check [guilabel]#Create from archetype# //<?dbfo-need height="6cm" ?> . If the Vaadin archetype is not in the list, click [guibutton]#Add archetype#, enter [guilabel]#GroupId# [literal]#++com.vaadin++#, [guilabel]#ArtifactId# [literal]#++vaadin-archetype-application++#, and [guilabel]#Version# [literal]#++LATEST++# (or a specific version number). ifdef::web[] + image::img/idea-maven-newproject-3.png[] endif::web[] + Click [guibutton]#OK# in the dialog. //<?dbfo-need height="8cm" ?> . Select the [literal]#++com.vaadin:vaadin-archetype-application++#. ifdef::web[] + image::img/idea-maven-newproject-4.png[] endif::web[] + Click [guibutton]#Next#. //<?dbfo-need height="8cm" ?> . Review the general Maven settings and settings for the new project. You may need to override the settings, especially if you are creating a Maven project for the first time. ifdef::web[] + image::img/idea-maven-newproject-5.png[] endif::web[] + Click [guibutton]#Finish#. Creating the Maven project takes some time as Maven fetches the dependencies. Once done, the project is created and the Maven POM is opened in the editor. [[getting-started.idea.maven.compiling]] === Compiling the Project To compile a Vaadin application using Maven, you can define a run/debug configuration to execute a goal such as [literal]#++package++# to build the deployable WAR package. It will also compile the widget set and theme, if necessary. See <> for more details. Compilation is included in the following instructions for deploying the application. [[getting-started.idea.maven.deploying]] === Deploying to a Server There exists Maven plugins for deploying to various application servers. For example, to deploy to Apache Tomcat, you can to configure the [literal]#++tomcat-maven-plugin++# and then execute the [literal]#++tomcat:deploy++# goal. See the documentation of the plugin that you use for more details. If no Maven plugin exists for a particular server, you can always use some lower-level method to deploy the application, such as running an Ant task. In the following, we create a run/debug configuration to build, deploy, and launch a Vaadin Maven application on the light-weight Jetty web server. . Select "Run > Edit Configurations". . Click [guibutton]#+# and select menu:Maven[] to create a new Maven run/debug configuration. . Enter a [guilabel]#Name# for the run configuration. For the [guilabel]#Command line#, enter "`package jetty:run`# to first compile and package the project, and then launch Jetty to run it. ifdef::web[] + image::img/idea-maven-run-1.png[] endif::web[] + Click [guibutton]#OK#. . Select the run configuration in the toolbar and click the [guibutton]#Run# button beside it. ifdef::web[] + image::img/idea-maven-run-2.png[] endif::web[] Compiling the project takes some time on the first time, as it compiles the widget set and theme. Once the run console pane informs that Jetty Server has been started, you can open the browser at the default URL http://localhost:8080/. 6 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495