opencart/opencart

OpenCart

Monday, July 30, 2018
by opencart
Repository
652 Watchers
4343 Stars
4,275 Installations

PHP
9 Dependents
0 Suggesters
3448 Forks
252 Open issues
50 Versions
67 % Grown

The README.md

OpenCart

Overview

, _(*1)

OpenCart is a free open source e-commerce platform for online merchants. OpenCart provides a professional and reliable foundation from which to build a successful online store., _(*2)

How to install

Please read the installation instructions included in the repository or download file., _(*3)

How to upgrade from previous versions

Please read the upgrading instructions included in the repository or download file., _(*4)

Reporting a bug

Read the instructions below before you create a bug report., _(*5)

Search the OpenCart forum, ask the community if they have seen the bug or know how to fix it.
Check all open and closed issues on the GitHub bug tracker.
If your bug is related to the OpenCart core code then please create a bug report on GitHub.
READ the changelog for the master branch
Use Google to search for your issue.
Make sure that your bug/issue is not related to your hosting environment.

If you are not sure about your issue, it is always best to ask the community on our bug forum thread, _(*6)

Important!, _(*7)

If your bug report is not related to the core code (such as a 3rd party module or your server configuration) then the issue will be closed without a reason. You must contact the extension developer, use the forum or find a commercial partner to resolve a 3rd party code issue.
If you would like to report a serious security bug please PM an OpenCart moderator/administrator on the forum. Please do not report concept/ideas/unproven security flaws - all security reports are taken seriously but you must include the EXACT details steps to reproduce it. Please DO NOT post security flaws in a public location.

How to contribute

Fork the repository, edit and submit a pull request., _(*8)

Please be very clear on your commit messages and pull request, empty pull request messages may be rejected without reason., _(*9)

Your code standards should match the OpenCart coding standards. We use an automated code scanner to check for most basic mistakes - if the test fails your pull request will be rejected., _(*10)

Local Development with Docker

This project includes a Docker-based environment for local development., _(*11)

Prerequisites

You must have Docker and Docker Compose installed on your machine. Docker Desktop is the easiest way to get them.
You must have make installed on your system (usually pre-installed on macOS and Linux distributions).

[!IMPORTANT], _(*12)

For Windows Users: It is strongly recommended to use the WSL 2 (Windows Subsystem for Linux) backend for Docker Desktop. You should clone this project inside your WSL distribution (e.g., Ubuntu 24.04) for best performance. Access your project via \\wsl$\Ubuntu-24.04\home\youruser\opencart from Windows Explorer if needed. Without WSL 2, file system performance will be extremely slow, making the application nearly unusable. Docker Desktop will typically prompt you to enable WSL 2 during installation., _(*13)

[!NOTE], _(*14)

OpenCart itself does not use any .env file for its configuration. The provided .env.docker file is only for configuring the Docker Compose environment. To avoid confusion with classic development workflows, this file is named .env.docker and placed inside the docker directory., _(*15)

Getting Started

Clone the repository to your local machine.
Initialize the project: bash make init
Build the images: bash make build
Start all services: bash make up

After the process is complete, your OpenCart store will be available at http://localhost., _(*16)

Common Commands

To stop the environment: bash make down
To view the logs from all services: bash make logs
To enter the PHP container: bash make php
To see all available commands: bash make help

Changing the PHP Version

The environment uses PHP 8.4 by default. You can easily switch to a different version by editing the PHP_VERSION variable in the docker/.env.docker file., _(*17)

For example, to use PHP 8.2, open docker/.env.docker and set:, _(*18)

PHP_VERSION=8.2

After changing the version, rebuild the images:, _(*19)

make build

Using Docker Compose Profiles for Optional Services

By default, only the core services (apache, php, mysql) are started. Optional services such as Adminer, Redis, Memcached, and PostgreSQL can be enabled using Docker Compose profiles., _(*20)

To enable one or more optional services, use the --profile flag and specify your env file:, _(*21)

Start with Adminer: bash make up profiles="adminer"
Start with Redis and Memcached: bash make up profiles="redis memcached"
Start all optional services: bash make up profiles="adminer redis memcached postgres"

[!TIP], _(*22)

You can combine any profiles as needed for your development workflow., _(*23)

Versioning

The version is broken down into 4 points e.g 1.2.3.4 We use MAJOR.MINOR.FEATURE.PATCH to describe the version numbers., _(*24)

A MAJOR is very rare, it would only be considered if the source was effectively re-written or a clean break was desired for other reasons. This increment would likely break most 3rd party modules., _(*25)

A MINOR is when there are significant changes that affect core structures. This increment would likely break some 3rd party modules., _(*26)

A FEATURE version is when new extensions or features are added (such as a payment gateway, shipping module etc). Updating a feature version is at a low risk of breaking 3rd party modules., _(*27)

A PATCH version is when a fix is added, it should be considered safe to update patch versions e.g 1.2.3.4 to 1.2.3.5, _(*28)

Releases

OpenCart will announce to developers 1 week prior to public release of FEATURE versions, this is to allow for testing of their own modules for compatibility. For bigger releases (ones that contain many core changes, features and fixes) an extended period will be considered following an announced release candidate (RC). Patch versions (which are considered safe to update with) may have a significantly reduced developer release period., _(*29)

The master branch will always contain an "_rc" postfix of the next intended version. The next "_rc" version may change at any time., _(*30)

Developer release source code will not change once tagged., _(*31)

If a bug is found in an announced developer release that is significant (such as a major feature is broken) then the release will be pulled. A patch version will be issued to replace it, depending on the severity of the patch an extended testing period may be announced. If the developer release version was never made public then the preceding patch version tag will be removed., _(*32)

To receive developer notifications about release information, sign up to the newsletter on the OpenCart website - located in the footer. Then choose the developer news option., _(*33)

License

GNU General Public License version 3 (GPLv3), _(*34)

project opencart

OpenCart

opencart/opencart

The README.md

OpenCart

Overview

How to install

How to upgrade from previous versions

Reporting a bug

How to contribute

Local Development with Docker

Prerequisites

Getting Started

Common Commands

Changing the PHP Version

Using Docker Compose Profiles for Optional Services

Versioning

Releases

License

Links

The Versions

dev-master

The Requires

3.1.0.0_a1

The Requires

1.5.6.1

1.5.6.2

2.0.3.1

2.1.0.0

1.5.5.1

1.5.6

2.0.2.0

2.0.3.0

2.0.0.0b2

2.0.0.0b3

2.0.1.0

2.0.1.1

2.0.0.0a2

2.0.0.0a3

2.0.0.0a4

2.0.0.0b1

1.5.6.4

2.0.0.0

2.0.0.0a1

2.1.0.2

1.5.6.3

2.1.0.0_rc1

2.1.0.1

2.3.x-dev

The Requires

dev-dev

The Requires

dev-dev-cloud

The Requires

3.0.2.0

The Requires

3.0.1.2

The Requires

3.0.1.1

The Requires

3.0.1.0

The Requires

3.0.0.2

The Requires

3.0.0.0

The Requires

dev-revert-5471-patch-18

The Requires

dev-revert-4530-patch-26

The Requires

dev-revert-4529-patch-25

The Requires

3.0.0.0_a1

The Requires

dev-dev-paypal-updates

The Requires

dev-revert-5259-patch-15

The Requires

dev-revert-5234-dev

The Requires