PHPackages                             commercetools/sunrise - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. commercetools/sunrise

AbandonedArchivedProject[Framework](/categories/framework)

commercetools/sunrise
=====================

Commercetools Sunrise PHP template shop

v0.1.1(10y ago)8516[8 issues](https://github.com/commercetools/commercetools-sunrise-php/issues)MITPHPPHP &gt;=5.6

Since Feb 4Pushed 6y ago25 watchersCompare

[ Source](https://github.com/commercetools/commercetools-sunrise-php)[ Packagist](https://packagist.org/packages/commercetools/sunrise)[ Docs](https://github.com/sphereio/commercetools-sunrise-php)[ RSS](/packages/commercetools-sunrise/feed)WikiDiscussions develop Synced 4w ago

READMEChangelogDependencies (19)Versions (7)Used By (0)

commercetools-sunrise-php
=========================

[](#commercetools-sunrise-php)

⚠️ **The Sunrise php shopfront implementation is now deprecated and will be decommissioned in 2020.**If you would nevertheless like to use it 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.

SUNRISE PHP is a template shopfront implementation that implements a complete online shop on the commercetools eCommerce platform using the following components:

- the [commercetools PHP SDK](https://github.com/commercetools/commercetools-php-sdk) and its corresponding [commons library](https://github.com/commercetools/commercetools-php-commons)
- the [commercetools SUNRISE](https://github.com/commercetools/sphere-sunrise-design) responsive HTML templates (handlebars syntax)
- the [symfony framework](http://symfony.com/) (using the MicrokernelTrait)

It aims to focus on being slim, easy to understand and fast, delegating reusabilty into the commons and symfony-components libraries.

Please read the [Changelog](CHANGELOG.md) before updating in any case.

Prerequisites
=============

[](#prerequisites)

- PHP (see the SDK for detailed requirements)
- composer

Run
===

[](#run)

To run, you need a project on the commercetools platform that contains some minimum necessary content (e.g. the sample data). Then get your project key, client ID and client secret from the merchant center and provide them in one of the following ways:

1. create a file `app/config/parameters.yml` with the following format:

```
parameters:
    env(SECRET_TOKEN): Secr3tT0ken
    env(CTP_CLIENT_ID): client-id
    env(CTP_CLIENT_SECRET): client-secret
    env(CTP_PROJECT): project-key
```

For local development purposes you can run the application in the php built-in web server. The `web` folder contains static assets and index.php as the *only* PHP file.

Production Site:

```
php bin/console server:run --env prod
```

Development Site:

```
php bin/console server:run
```

Open

Develop
=======

[](#develop)

To improve the template, we are happily receiving pull requests with improvements and bug fixes. If you'd like to change bigger things or add features it's a good idea to discuss the idea in a github issue first.

IMPORTANT: The composer configuration clones the PHP commons library and the sunrise designs inside the `vendor` directory. So pay attention when doing git operations with changes in these files.

Using the command line
----------------------

[](#using-the-command-line)

### Available console commands

[](#available-console-commands)

```
php bin/console list

```

### Cache warm up

[](#cache-warm-up)

```
php bin/console cache:warmup

```

Deployment
----------

[](#deployment)

### Heroku

[](#heroku)

For an easy and fast deployment of your application we recommend [heroku](https://www.heroku.com):

[![Deploy](https://camo.githubusercontent.com/3da7ea007288c7a8b14c8c84f0836d66ba8f82bd2f3b72fb7e0e72e19a16d28f/68747470733a2f2f7777772e6865726f6b7563646e2e636f6d2f6465706c6f792f627574746f6e2e706e67)](https://heroku.com/deploy?template=https://github.com/commercetools/commercetools-sunrise-php/tree/develop)

### Docker

[](#docker)

The Sunrise app is delivered with a docker compose configuration.

```
docker run -v $PWD:/var/www/symfony -w /var/www/symfony --rm=true jaysde/symfony-php-fpm composer install --prefer-dist
docker-compose up
```

This starts a nginx and a php-fpm docker container serving the application.

Create your own shop
====================

[](#create-your-own-shop)

Fork and forge your own eCommerce solution from it.

More specifically:

- fork the project or just copy the code (the MIT license of this code and the SUNRISE design allow unrestricted commercial use and modification)
- you may want to change the namespace of some things to your own project's name (TODO the template could use a generic namespace from the beginning)
- EITHER override and change the SUNRISE design by creating a `templates` directory in the project folder and overriding the `*.hbs` filenames you find in `vendor/commercetools/sunrise-design/templates`
- OR create an own HTML and templates structure from scratch using your preferred tools and template language
- add and change stuff as you like
- Be nice and contribute useful generic helpers back to the OSS commons library.

###  Health Score

24

—

LowBetter than 31% of packages

Maintenance0

Infrequent updates — may be unmaintained

Popularity17

Limited adoption so far

Community20

Small or concentrated contributor base

Maturity52

Maturing project, gaining track record

 Bus Factor3

3 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~260 days

Total

5

Last Release

2755d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/1084585?v=4)[commercetools](/maintainers/commercetools)[@commercetools](https://github.com/commercetools)

---

Top Contributors

[![jenschude](https://avatars.githubusercontent.com/u/10562872?v=4)](https://github.com/jenschude "jenschude (1 commits)")[![nikossvnk](https://avatars.githubusercontent.com/u/3993858?v=4)](https://github.com/nikossvnk "nikossvnk (1 commits)")[![schleichardt](https://avatars.githubusercontent.com/u/1320833?v=4)](https://github.com/schleichardt "schleichardt (1 commits)")[![skyriakou](https://avatars.githubusercontent.com/u/44841399?v=4)](https://github.com/skyriakou "skyriakou (1 commits)")[![ValeSauer](https://avatars.githubusercontent.com/u/7767250?v=4)](https://github.com/ValeSauer "ValeSauer (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/commercetools-sunrise/health.svg)

```
[![Health](https://phpackages.com/badges/commercetools-sunrise/health.svg)](https://phpackages.com/packages/commercetools-sunrise)
```

###  Alternatives

[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

585.4M524](/packages/shopware-core)[pimcore/pimcore

Content &amp; Product Management Framework (CMS/PIM/E-Commerce)

3.8k3.8M464](/packages/pimcore-pimcore)[shopware/platform

The Shopware e-commerce core

3.4k1.5M3](/packages/shopware-platform)[open-dxp/opendxp

Content &amp; Product Management Framework (CMS/PIM)

9317.2k55](/packages/open-dxp-opendxp)[prestashop/prestashop

PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers.

9.1k16.8k](/packages/prestashop-prestashop)[oro/platform

Business Application Platform (BAP)

642140.7k104](/packages/oro-platform)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
