sphere-sunrise 🌅

The next generation shop template.

⚠️ Notice this template is in a very early stage of development.

Unfortunately we do not currently have any finished template that uses our last version of the SPHERE JVM SDK. If you are looking for a more complete project you can check our Fedora template, but be aware that this project uses the older version SPHERE Play SDK.

• Demo: https://sunrise.sphere.io
• Javadoc

Preconditions

• install Java 8
• install SBT, Mac/Linux users can use the SBT script in the base folder (use ./sbt instead of sbt in commands)

Run it locally

• on Linux/Mac: ./activator ~run
• on Windows: activator ~run

The output will be like

[info] play - Listening for HTTP on /0:0:0:0:0:0:0:0:9000
(Server started, use Ctrl+D to stop and go back to the console...)

• open http://localhost:9000 in your browser and set the SPHERE.IO project credentials

Integration tests against SPHERE.IO backend

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

export SPHERE_SUNRISE_IT_PROJECT="your-project-key"
export SPHERE_SUNRISE_IT_CLIENT_SECRET="your-the-client-secret"
export SPHERE_SUNRISE_IT_CLIENT_ID="your-client-id"

• sbt it:test

Deployment

For an easy and fast deployment of your application we recommend heroku:

Docker

You can also use a ready-to-run docker container.

$ docker run -it --rm -p 9000:9000 sphereio/sunrise

Related projects

• https://github.com/sphereio/sphere-sunrise-data
• https://github.com/sphereio/sphere-sunrise-scenarios
• https://github.com/sphereio/sphere-sunrise-design
• https://github.com/sphereio/sphere-jvm-sdk