commercetools / commercetools-sunrise-java

The next generation shop framework by commercetools

Sunrise Java Shop Framework 🌅

⚠️ Sunrise Java is now deprecated and will be decommissioned in 2020. Instead please use our new demo shop Sunrise SPA. If you would nevertheless like to use Sunrise Java for your own developments you should fork this repository under the given license and continue developing your version, but please be aware that there will be no more updates and no support provided to this framework.

The next generation shop framework.

• Demo
• Documentation
• Javadoc

Installation

Sunrise Starter Project

The recommended way to start using Sunrise is to clone the Sunrise Starter Project and use it as a template project. It already contains all dependencies (i.e. Sunrise Framework and Theme) and configurations needed to run your Sunrise-based project.

Starting from scratch

Alternatively you can start your own Play Framework project and configure it yourself, using Sunrise as dependency:

val sunriseFrameworkVersion = "1.0.0-M9" // or desired version
libraryDependencies ++= Seq(
  // add Sunrise Framework dependencies as needed, e.g.:
  "com.commercetools.sunrise" %% "product-catalog" % sunriseFrameworkVersion,
  "com.commercetools.sunrise" %% "shopping-cart" % sunriseFrameworkVersion,
  "com.commercetools.sunrise" %% "my-account" % sunriseFrameworkVersion,
  "com.commercetools.sunrise" %% "wishlist" % sunriseFrameworkVersion,
  // add the desired Sunrise Theme as dependency, e.g.:
  "com.commercetools.sunrise" % "commercetools-sunrise-theme" % "0.61.1"
)

These dependencies provide default Controllers which can be enabled by extending them into your own Controller and registering a route for it.

For example, if we wanted to enable an endpoint to see the contents of the cart, we would simply extend the SunriseCartDetailController:

// here you can register controller components
@RegisteredComponents(CartOperationsControllerComponentSupplier.class)
public final class CartDetailController extends SunriseCartDetailController {

    @Inject
    public CartDetailController(final ContentRenderer contentRenderer,
                                final CartFinder cartFinder,
                                final CartDetailPageContentFactory pageContentFactory) {
        // parameters that you can change via injection
        super(contentRenderer, cartFinder, pageContentFactory);
    }

    @Nullable
    @Override
    public String getTemplateName() {
        // here goes the name of your template
        return "cart";
    }
    
    // here you can override methods to change behaviour
}

Then we only need to associate our CartDetailController to a route with the desired pattern in conf/routes:

# Shows the details of the cart belonging to the current session
GET  /:languageTag/cart       @controllers.CartDetailController.show(languageTag: String)

Accessing http://localhost:9000/en/cart should now allow us to see the contents of our cart.

Check Sunrise Starter Project to adjust any other required configuration.

Integration tests against commercetools platform

• Setup your environment variables (use a test project), so you need not to put your shop credentials under version control:

export SUNRISE_IT_CTP_PROJECT_KEY="your-CTP-project-key"
export SUNRISE_IT_CTP_CLIENT_SECRET="your-CTP-client-secret"
export SUNRISE_IT_CTP_CLIENT_ID="your-CTP-client-id"

• sbt it:test

Related projects

Sunrise Starter Project

The starting point to build your own online shop project

https://github.com/commercetools/commercetools-sunrise-java-starter

Sunrise Theme

Handlebars templates + i18n messages + web assets

https://github.com/commercetools/commercetools-sunrise-theme

Sunrise Data

Example data used on our demo

https://github.com/commercetools/commercetools-sunrise-data

commercetools JVM SDK

SDK for JVM languages to communicate with comercetools projects

https://github.com/commercetools/commercetools-jvm-sdk

commercetools-sunrise-java's Issues

CMS

prismic.io: Free for Open Source and Open Content

https://blog.prismic.io/U1j14AEAACoA5hyt/prismicio-free-for-open-source-and-open-content

@lauraluiz Should we integrate it?

Product search with autocomplete suggestions

Create structure of SASS files.

Setup Code Coverage

Support multi-language products

The shop should view products in different languages

Move to Java 8

Show integration of basic auth

create Play module in own SBT module in SDK like https://github.com/schleichardt/play-modules/tree/master/basicAuth

Emit warning if project not started with Java 8

https://github.com/typesafehub/reactive-stocks-java8/blob/master/build.sbt#L18

Demo case content negotiation for JSON (AJAX) and HTML

• http://www.playframework.com/documentation/2.3.x/JavaContentNegotiation
• https://gist.github.com/schleichardt/4e84b6136c81ae317b0e

    public Result index() {
        return result(OK).
                json(() -> Json.parse("{\"foo\":\"bar\"}")).
                html(() -> index.render(data().build()));
    }

@lauraluiz I think this approach is better than action composition since there are no surprises in the background/it is obvious that the endpoint supports JSON and HTML and in addition the JSON stuff or the HTML stuff will be only executed if needed.

This is only nice possible with Java 8.

Document Credential Injection dev/prod/test

Add CSRFFilter

security issue

Use an HTML Template

Setup Javadoc page/publish Javadoc

Add product data

@lauraluiz
For our new shop, how do we fill the shop with product data? With the client or the CLI? The example product data should be under version control.

XML Sitemap

see #37

• for all pages, including CMS, canonicals

Document Contribution Guidelines

• pull requests reviewied by Laura and me
• see also commercetools/sphere-play-sdk#75

Create structure of Coffeescript files.

SBT settings for template imports

• Sphere models
• Java 8 Optional

Set code coverage threshold in jacoco

Use multi currency prices based on selected country

Setup Unidoc

Update to Play 2.3.3

https://groups.google.com/forum/#!topic/play-framework/EBxqGoMn610

Find/create a logo

Migrate to Play 2.3.1

Setup Integration Test Scope

Test against different Scala versions

http://docs.travis-ci.com/user/languages/scala/

Idea, use sunrise as showcase for http api features

• example for filters and facets link product search html page & code

Create health check endpoint

see commercetools/sphere-play-sdk#94

Deploy test coverage reports to gh-pages

Check if JavaDoc is really deployed, deploy JavaDoc on release

Which locales do we support?

I think we should at least support German and English. @lauraluiz

Use on heroku different application secret (encrypted)

Create a shop controller instance with a sphere Play Java client member

• it will show the dependency injection and the testability on a simple example
• for now fetch the categories on every request, later we will build a plugin an use a cache

Setup Travis Job

Use customerGroup pricing

Setup SASS

Setup Native Packaging

Provide setup for JS specs

Create a favicon

Use Google Guice for DI

convert to activator template

Create and link screenshot

Pagination contains rel=next and rel=prev

see #37

http://googlewebmastercentral.blogspot.de/2011/09/pagination-with-relnext-and-relprev.html

usa captchas for signup

Onboarding manual with SBT launcher script

Add MVC guidelines and best practices

See: https://github.com/commercetools/sphere-maximilian/commit/b036f38ec9ab3d1c16fdd6e330bab9a8ab4c7f4e#commitcomment-6726975

Code quality style/best practices list

see #37

• Post Redirect Get http://www.codeproject.com/Tips/433399/PRG-Pattern-Post-Redirect-Get (basically F5 does not cause to resubmit a form)
• alt tags for all pictures?
• width and height attributes for sliders (speed/rendering/performance)

Create running demo application

• Heroku?

SEO

@skedapeda collect the things we need to consider for SEO and make an appointment with @lauraluiz and @schleichardt, please.

provide alternative links in other languages (hreflang)

https://support.google.com/webmasters/answer/189077?hl=de

see #37