README

4.4のリリース内容・計画はロードマップをご確認ください。

本ドキュメントはEC-CUBEの開発者を主要な対象者としております。
パッケージ版はEC-CUBEオフィシャルサイトで配布しています。
カスタマイズやEC-CUBEの利用、仕様に関しては開発コミュニティをご利用ください。
本体開発にあたって不明点などあればIssueをご利用下さい。
EC-CUBE 3系の保守については、 EC-CUBE/ec-cube3にて開発を行っております。
EC-CUBE 2系の保守については、 EC-CUBE/ec-cube2にて開発を行っております。

インストール

EC-CUBE 4.4のインストール方法

開発ドキュメントのインストール方法の手順に従ってインストールしてください。

CSS の編集・ビルド方法

Sass を使用して記述されています。 Sass のソースコードは html/template/{admin,default}/assets/scss にあります。前提として [https://nodejs.org/ja/] より、 Node.js をインストールしておいてください。

以下のコマンドでビルドすることで、 html/template/**/assets/css に CSS ファイルが出力されます。

npm ci # 初回およびpackage-lock.jsonに変更があったとき
npm run build # Sass のビルド

docker compose を使用している場合は以下のコマンドを実行してください

# 初回およびpackage-lock.jsonに変更があったとき
docker compose -f docker-compose.yml -f docker-compose.dev.yml -f docker-compose.nodejs.yml run --rm -T nodejs npm ci
# Sass のビルド
docker compose -f docker-compose.yml -f docker-compose.dev.yml -f docker-compose.nodejs.yml run --rm -T nodejs npm run build

JavaScript のビルド方法

フロントエンドで使用する JavaScript のライブラリは npm で管理されています。 JavaScript のライブラリは esbuild でバンドル/minifyされます。バンドルするライブラリを変更する場合は、テンプレートごとに以下の bundle.js を修正し、リビルドしてください。

npm ci # 初回およびpackage-lock.jsonに変更があったとき
npm run build # Sass 及び JavaScript のビルド

ファイルの変更を監視して差分ビルドする場合は以下を実行してください。

npm start

docker compose を使用している場合は以下のコマンドを実行してください

# 初回およびpackage-lock.jsonに変更があったとき
docker compose -f docker-compose.yml -f docker-compose.dev.yml -f docker-compose.nodejs.yml run --rm -T nodejs npm ci
# Sass 及び JavaScript のビルド
docker compose -f docker-compose.yml -f docker-compose.dev.yml -f docker-compose.nodejs.yml run --rm -T nodejs npm run build

動作確認環境

Apache 2.4.x (mod_rewrite / mod_ssl 必須)
PHP 8.2.x / 8.3.x / 8.4.x / 8.5.x
PostgreSQL 13.x 〜 18.x / MySQL 8.4.x (LTS)
ブラウザー：Google Chrome

詳しくは開発ドキュメントのシステム要件をご確認ください。

ドキュメント

EC-CUBE 4.x 開発ドキュメント@doc4.ec-cube.net

EC-CUBE 4.x 系の仕様や手順、開発Tipsに関するドキュメントを掲載しています。修正や追記、新規ドキュメントの作成をいただく場合、以下のレポジトリからPullRequestをお送りください。 https://github.com/EC-CUBE/doc4.ec-cube.net

開発への参加

EC-CUBE 4.4の不具合の修正、機能のブラッシュアップを目的として、継続的に開発を行っております。
コードのリファクタリング、不具合修正以外のPullRequestを送る際は、Pull Requestのコメントなどに意図を明確に記載してください。

開発環境の構築・ブランチ運用（PR の宛先は 4.4）・PR を出す前に通すべき CI チェック（コードスタイル / 静的解析 / Rector / テスト）・ライセンスヘッダなど、コントリビューションの具体的な手順は CONTRIBUTING.md を参照してください。レイヤ別の実装規約は AGENTS.md に集約しています。

Pull Requestの送信前に、Issueにて提議いただく事も可能です。 Issuesの利用方法については、こちらをご確認ください。

Slackでも本体の開発に関する意見交換などを行っております。

コピーライトポリシーへの同意

コードの提供・追加、修正・変更その他「EC-CUBE」への開発の御協力（Issue投稿、Pull Request投稿など、GitHub上での活動）を行っていただく場合には、 EC-CUBEのコピーライトポリシーをご理解いただき、ご了承いただく必要がございます。 Issueの投稿やPull Requestを送信する際は、EC-CUBEのコピーライトポリシーに同意したものとみなします。

English

What is EC-CUBE?

EC-CUBE is Japan's leading open-source e-commerce platform, powering over 35,000 online stores. It provides a full-featured, highly customizable solution specifically designed for the Japanese market.

Key differentiators:

Japanese Tax System: Native support for Japan's reduced tax rate (軽減税率) and consumption tax rules
Point System: Built-in customer point rewards
Multiple Shipping: Send a single order to multiple addresses
Plugin Ecosystem: Extensible via plugins with a dedicated marketplace (Owners Store)

Technology Stack

Component	Technology
Language	PHP 8.2 / 8.3 / 8.4 / 8.5
Framework	Symfony 7.4
ORM	Doctrine ORM 3.x, DBAL 4.x
Template	Twig 3.x
Database	PostgreSQL 13–18 / MySQL 8.4 LTS
Frontend	Sass, esbuild, Bootstrap 5.3, jQuery 4.x

Quick Start

Docker (Recommended)

git clone https://github.com/EC-CUBE/ec-cube.git
cd ec-cube
docker compose -f docker-compose.yml -f docker-compose.pgsql.yml up -d
# Access http://localhost:8080

Composer

composer create-project ec-cube/ec-cube ec-cube "4.4.x-dev" --keep-vcs
cd ec-cube
bin/console eccube:install

ec-cube / ec-cube

Package info

Security

Statistics