Skip to content

Commit

Permalink
converted some URLs to links; added screenshot
Browse files Browse the repository at this point in the history
  • Loading branch information
synthomat committed Nov 5, 2015
1 parent c77942e commit ec7de82
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
Addressbook Tutorial
====================

This tutorial teaches you some of the basic concepts in Vaadin Framework. It is meant to be
This tutorial teaches you some of the basic concepts in [Vaadin Framework](https://vaadin.com). It is meant to be
a fast read for learning how to get started - not an example on how application should be
designed. Please note this example uses and requires Java 8 to work.

![Addressbook Screenshot](addressbook_screenshot.png "Addressbook Screenshot")


Running the example from the command line
-------------------
```
$ mvn jetty:run
```

Open [http://localhost:8080/](http://localhost:8080/)

Open http://localhost:8080/

Importing in IntelliJ IDEA 14
--------------------
Expand All @@ -21,7 +26,7 @@ To get the project up and running in IDEA, do:
- The URL to use is https://github.com/vaadin/addressbook.git
- If you get a message about "Non-managed pom.xml file found". Choose "Add as Maven Project"
- If you get a message about no JDK or SDK being selected. Choose "Configure" and select your installed JDK. You can also set the JDK using File -> Project Structure
- To start the project, find the "Maven Projects" tab on the right hand side of the screen and navigate to
- To start the project, find the "Maven Projects" tab on the right hand side of the screen and navigate to
- Vaadin Web Application -> Plugins -> jetty -> jetty:run
- Click the play button or right click and select Run (Select Debug instead to run in debug mode)

Expand All @@ -47,13 +52,13 @@ These instructions were tested on Eclipse IDE for Java EE Developers Luna SR2. Y
To checkout and run the project in Eclipse, do:
- File -> Import...
- Check out Maven Projects from SCM
- Choose Git from SCM menu
- Choose Git from SCM menu
- If you do not see "Git" in the SCM menu, click "Find more SCM connectors in the m2e Marketplace" and install "m2e-egit". Restart Eclipse and start over.
- Set the repository URL to https://github.com/vaadin/addressbook.git
- Right click the imported "addressbook" and choose Run As -> Maven Build...
- Right click the imported "addressbook" and choose Run As -> Maven Build...
- Set the goal to "jetty:run" and click "Run"

You should now have a Jetty server running on localhost:8080. Navigate to http://localhost:8080 to play with the application
You should now have a Jetty server running on localhost:8080. Navigate to [http://localhost:8080/](http://localhost:8080/) to play with the application

To use the built in server adapters of Eclipse, instead of doing "Run As -> Maven Build..." you can do
- Run As -> Run on Server
Expand Down
Binary file added addressbook_screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ec7de82

Please sign in to comment.