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

The next generation shop framework by commercetools
https://github.com/commercetools/commercetools-sunrise-java

commercetools shop-framework sunrise sunrise-java

Last synced: 5 months ago
JSON representation

The next generation shop framework by commercetools

• Host: GitHub
• URL: https://github.com/commercetools/commercetools-sunrise-java
• Owner: commercetools
• License: apache-2.0
• Created: 2014-05-21T20:20:52.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2019-10-15T13:52:18.000Z (almost 6 years ago)
• Last Synced: 2025-04-20T15:17:56.029Z (6 months ago)
• Topics: commercetools, shop-framework, sunrise, sunrise-java
• Language: Java
• Homepage: https://demo.commercetools.com
• Size: 58.4 MB
• Stars: 46
• Watchers: 100
• Forks: 33
• Open Issues: 91
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Sunrise Java Shop Framework :sunrise:

==============

[![Build Status](https://travis-ci.org/commercetools/commercetools-sunrise-java.svg?branch=master)](https://travis-ci.org/commercetools/commercetools-sunrise-java)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.commercetools.sunrise/product-catalog_2.11/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.commercetools.sunrise/product-catalog_2.11)

[![stability-frozen](https://img.shields.io/badge/stability-locked-blue.svg)](https://github.com/orangemug/stability-badges#locked)

[![Heroku](http://heroku-badge.herokuapp.com/?app=ct-sunrise-prod&style=flat&svg=1)](http://ct-sunrise-prod.herokuapp.com/)

> :warning: **Sunrise Java is now deprecated and will be decommissioned in 2020.**

Instead please use our new demo shop [Sunrise SPA](https://github.com/commercetools/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](https://demo.commercetools.com)

* [Documentation](manual/)

* [Javadoc](https://commercetools.github.io/commercetools-sunrise-java/javadoc/index.html)

## Installation

### Sunrise Starter Project

The recommended way to start using Sunrise is to clone the [Sunrise Starter Project](https://github.com/commercetools/commercetools-sunrise-java-starter) 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:

```sbt

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`:

```java

// 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`:

```scala

# 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](http://localhost:9000/en/cart) should now allow us to see the contents of our cart.

Check [Sunrise Starter Project](https://github.com/commercetools/commercetools-sunrise-java-starter) 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:

```bash

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