5 Minute Tutorial

This tutorial describes how to get into development with Ilves in 5 minutes and publish the result to Heroku.

The tutorial is based on embedded Jetty. For traditional WAR approach see: WAR Project Guide

Clone

Clone the seed project either first via github to your own account or directly to your workstation with the following command:

git clone https://github.com/bubblecloud/ilves-seed.git

You can alternatively use WAR seed project in which case follow the guide in project README file to build and execute the project:

https://github.com/bubblecloud/ilves-war-seed

Database (Optional)

• Install PostgreSQL database software if you prefer it instead of HSQL.
• Create database with your chosen owner user name and password.

Configure (Optional)

Edit configuration file in the project root and choose configuration for your preferred database:

site-ext.properties

Build

Build the project:

mvn clean install

Run

Run the project in Windows:

ilves

Run the project on Linux and Mac:

chmod u+x ilves
./ilves

View the project in Browser:

• URL: http://127.0.0.1:8080/
• Login: admin@admin.org
• Password: password

Import

Import the project to the IDE as maven project by choosing the maven build file in the root folder:

pom.xml

Verify

Run the main class from the IDE:

src/main/java/org/bubblecloud/ilves/Ilves.java

View the project in Browser:

• https://127.0.0.1:8443/
• Login: admin@admin.org
• Password: password

Develop

1. Modify the HelloComponent class to contain your custom Vaadin functionality:

src/main/java/org/bubblecloud/ilves/HelloComponent.java

2. Modify localization file to add your own localization key value pairs for english:

src/main/resources/custom-localization.properties

3. Modify Sass style sheet to change the look and feel of your site:

src/main/resources/VAADIN/themes/ilves/styles.sass

4. Add more pages and modify navigation in the Ilves main class:

src/main/java/org/bubblecloud/ilves/IlvesMain.java

Publish to Heroku

1. Register to Heroku.com.

2. Install Heroku toolbelt from Heroku.com.

3. Login to Heroku from git bash:

heroku login

4. Create heroku app by executing in your project root:

heroku create

5. After committing and pushing your changes to your master repository you are ready to publish to Heroku:

git push heroku master