vaadin / bakery-app-starter-fw8-spring Goto Github PK

View Code? Open in Web Editor NEW

0.0 23.0 2.0 7.55 MB

Internal repository for Bakery App Starter for FW8 and Spring

License: Other

Java 81.92% HTML 8.32% CSS 6.60% Shell 0.86% Scala 2.30%

bakery-app-starter-fw8-spring's Introduction

Running the project

mvn spring-boot:run

Wait for the application to start

Open http://localhost:8080/ to view the application.

Default credentials are [email protected]/admin for admin access and [email protected]/barista for normal user access.

Running the project as an executable jar

The project is configured to automatically make the build artifact runnable using java -jar. By default you can thus also run the project by executing the war file:

java -jar target/###artifactId###-1.0-SNAPSHOT.war

If you want to produce a jar file instead of a war file, change the packaging type in pom.xml to <packaging>jar</packaging>.

You also need to configure Vaadin resources and Designer templates to be included into the jar:

<build>
 ...
    <resources>
        <resource>
            <directory>src/main/webapp</directory>
                <filtering>false</filtering>
        </resource>
        <resource>
            <directory>src/main/resources</directory>
                <filtering>false</filtering>
        </resource>
    </resources>
 ...
</build>

Running integration tests

Integration tests are implemented using TestBench. The tests take tens of minutes to run and are therefore included in a separate profile. To run the tests, execute

mvn verify -Pit

and make sure you have a valid TestBench license installed.

Running scalability tests

Scalability tests can be run as follows

Configure the number of concurrent users and a suitable ramp up time in the end of the src/test/scala/*.scala files, e.g.: setUp(scn.inject( rampUsers(50) over (60 seconds)) ).protocols(httpProtocol)
If you are not running on localhost, configure the baseUrl in the beginning of the src/test/scala/*.scala files, e.g.:

val baseUrl = "http://my.server.com"
Make sure the server is running at the given URL. To run the local server, use mvn spring-boot:run
Start a test from the command line, e.g.: mvn -Pscalability gatling:execute -Dgatling.simulationClass=com.vaadin.starter.bakery.Barista
Test results are stored into target folder, e.g.: target/gatling/Barista-1487784042461/index.html

Developing the project

The project can be imported into the IDE of your choice as a Maven project

The views are created using Vaadin Designer. To edit the views visually, you need to install the Vaadin Designer plug-in.

In Eclipse, open Marketplace, search for "vaadin" and install Vaadin Designer 2.x

In IntelliJ, go to "Preferences" -> "Plugins" -> "Browse Repositories", search for "Vaadin Designer 2" and install "Vaadin Designer"

License

A paid Pro or Prime subscription is required for creating a new software project from this starter. After its creation, results can be used, developed and distributed freely, but licenses for the used commercial components are required during development. The starter or its parts cannot be redistributed as a code example or template.

For full terms, see LICENSE

bakery-app-starter-fw8-spring's People

Contributors

Watchers

Forkers

eoscorp mvysny

bakery-app-starter-fw8-spring's Issues

Document "Setting up continous integration"

How do I setup the project on GitHub + Travis so that each PR is validated and tested automatically.

While the target audience likely does not use Travis, this will still cover the basic requirements for a CI setup. It can be later expanded to cover e.g. GitLab + Jenkins

Scrolling board will switch over to scrolling grid if scroll causes the grid to be under the cursor

Steps to reproduce

Place cursor on top of board close to the bottom right corner, but not on the grid
Do a big scroll gesture to get to the bottom of the board

Expected result

View is scrolled all the way down

What happens

View scrolls down until cursor is on top of Grid, and then Grid starts to scroll instead of Board.

The note at the bottom of the page should always be visible

The note could have position:fixed;bottom:0 and the main view content should have enough margin-bottom so that you can scroll all the way down.

Layout breaks when saving empty order

Name/phone breaks the layout when they get error styles. Updating the fields fixes the layout proiblems

Implement proper CRUD logic for all admin views

The current one is missing a lot of the details

set button caption according to state
enabling/disabling buttons according to state (save/add/cancel/delete)
navigating away when the form is open (show confirmation dialog)
selecting another item when the form is open (show confirmation dialog)

After logging in you should end up on the desired view

If you go to http://localhost:8080/#!order/3335 when not being logged in, you should end up on http://localhost:8080/#!order/3335 after logging in. Right now you end up on the default view depending on the user

Starting up server takes too long

Setting up server takes about 20s as it sets up a lot of repositories. Every time you make a code change and deploy it, you have to wait 20s for the redeployment. This is a productivity killer.

Product rows with product==null should be ignored

It should be possible to click "add item" N times, and still go to the next step w/o touching those.

remove all "empty" rows when submitting

Add a delete button for products

A delete button will be added to each product row.
Setting quantity to 0 for a row should have the same effect.

Document "Architecture overview"

"How does Designer help"
"How are test setup and run"
"How authorization works”
“What are the architectural boundaries and when to cross them

"Vaadin-Refresh" in login.html does not consider context path

Vaadin-Refresh: /login.htmlredirects to http://host.com/login.html, regardless of context path

Presenters must be serializable

Include license

TestBench test

There should be tests that prove all parts of the UI works

Document "Getting started and customizing"

"How do you get the application up and running"
"How do you add a view"
"How do you add an entity"
“Tips for development workflow”
"How should you run things to get changes to show up as quickly as possible in your browser"

Visual Design

Active menu item should be highlighted

Verify that the generated database tables make sense

There should be a way to navigate back to the orders list from the edit view

Document scalability test

How can they be run locally
How can they be run on a CI for validation that a patch does not destroy performance

Sometimes you need to click twice on a menu item to navigate

This is somewhat random - sometimes it works, most of the time it does not, especially on an iPhone

Style orders grid status indicators

Implement sorting properly in the admin views

Instructions to everything.

Need documentation on how to get started with it. Also README could be longer.

Running application, Adding to IDE, running tests, what can be found where, etc...

Verify that Hibernate can be changed to EclipseLink

Orders grid shows ellipsis for date

When the first column should say

Today
5/5/16

it says

Today
5/5/...

cause by vaadin/framework#8502

Document how to deploy to AWS Elastic Beanstalk

Starting point: You have cloned the project
End result: The app is running in AWS Elastic Beanstalk

Improve order read-only-mode legibility

Just making the fields read-only makes for a very hard to scan page, with too much space etc.

Optimize login page by using inline theme

There is no point in loading the full Valo theme to show the login page. Instead the login page should be stand alone and Valo should be loaded in the background while the user is logging in

Remove bulletin board

Decided not to include a bulletin board in the initial version

Fix password in user admin

Should not display the encrypted password, just allow changing password

Login page: Pressing enter when cursor on 'username' or 'password' field should trigger the 'login' action / button

Scalability tests

There should be scalability tests and a report proving the scalability

Document "Deployment and configuration for production"

"How do I use a real DB and disable data generation"
"How do I get it up and running on Wildfly/Tomcat/…"
"How do I deploy it to Beanstalk?" (covered by a separate issue)

Have an simple execution script in project root.

I keep forgetting that the run command in mvn spring-boot:run. I think we should have a script so that you can only type ./run in root to start up the project. It could directly call spring-boot. I think JHipster had something similar.