2017 © Pedro Peláez
 

project sunrise

Commercetools Sunrise PHP template shop

image

commercetools/sunrise

Commercetools Sunrise PHP template shop

  • Saturday, July 14, 2018
  • by jays-de
  • Repository
  • 24 Watchers
  • 4 Stars
  • 50 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 6 Forks
  • 9 Open issues
  • 7 Versions
  • 0 % Grown

The README.md

commercetools-sunrise-php

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

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

Please read the Changelog before updating in any case., (*3)

Prerequisites

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

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:, (*4)

  1. create a file app/config/parameters.yml with the following format:
parameters:
    secret: <your application secret>
    commercetools.client_id: <your client id>
    commercetools.client_secret: <your client secret>
    commercetools.project: <your 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., (*5)

Production Site:, (*6)

php bin/console server:run --env prod

Development Site:, (*7)

php bin/console server:run

Open http://localhost:8000/, (*8)

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., (*9)

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., (*10)

Using the command line

Available console commands

php bin/console list

Cache warm up

php bin/console cache:warmup

Deployment

Heroku

For an easy and fast deployment of your application we recommend heroku:, (*11)

Deploy, (*12)

Docker

The Sunrise app is delivered with a docker compose configuration., (*13)

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., (*14)

Create your own shop

Fork and forge your own eCommerce solution from it., (*15)

More specifically:, (*16)

  • 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.

The Versions

14/07 2018

dev-develop

dev-develop https://github.com/commercetools/commercetools-sunrise-php

Commercetools Sunrise PHP template shop

  Sources   Download

MIT

The Requires

 

The Development Requires

14/07 2018

dev-master

9999999-dev https://github.com/commercetools/commercetools-sunrise-php

Commercetools Sunrise PHP template shop

  Sources   Download

MIT

The Requires

 

The Development Requires

14/07 2018

v0.2.0-alpha.2

0.2.0.0-alpha2 https://github.com/commercetools/commercetools-sunrise-php

Commercetools Sunrise PHP template shop

  Sources   Download

MIT

The Requires

 

The Development Requires

13/07 2018

v0.2.0-alpha.1

0.2.0.0-alpha1 https://github.com/commercetools/commercetools-sunrise-php

Commercetools Sunrise PHP template shop

  Sources   Download

MIT

The Requires

 

The Development Requires

13/07 2018

dev-update_dependencies

dev-update_dependencies https://github.com/commercetools/commercetools-sunrise-php

Commercetools Sunrise PHP template shop

  Sources   Download

MIT

The Requires

 

The Development Requires

09/02 2016

v0.1.1

0.1.1.0 https://github.com/sphereio/commercetools-sunrise-php

  Sources   Download

MIT

The Requires

 

The Development Requires

04/02 2016

v0.1.0

0.1.0.0 https://github.com/sphereio/commercetools-sunrise-php

  Sources   Download

MIT

The Requires

 

The Development Requires