Flow is a responsive theme for all OXID eShop editions from version 4.10 (Community Edition, Professional Edition) or 5.3 (Enterprise Edition) on. It will become the default theme from OXID eShop version 6 on, and will replace the Azure theme.
Step 1: Select the appropriate branch
Currently there are two main branches for Flow:
b-1.0contains Flow for OXID eShop version 4.10/5.3
mastercontain Flow for OXID eShop version 6.0 or higher
Step 2: Get the source code
Check out the appropriate branch for your OXID eShop version into the shop's
cd DOCUMENT_ROOT/Application/views/ git clone -b BRANCH_NAME https://github.com/OXID-eSales/flow_theme.git flow
You should now have a new folder
Step 3: Prepare the database
In order to install the theme options, import the
setup.sql into your database.
Option 1: Console
mysql -u MYSQL_USER -p SHOP_DATABASE < flow/setup.sql
Option 2: Shop Admin: Service -> Tools
If you have a local copy of flow files, go to Service -> Tools in Shop Admin, upload flow/setup.sql and click "start update" button
Step 4: Prepare the
out folder can be prepared in two possible ways. The first option is to use symbolic links, the second is to copy. Using a symbolic link is strongly recommended, as otherwise you would have do the copying everytime Flow is updated.
Option 1: Symbolic Linking
Link the theme's
out directory to the
out directory of the shop:
ln -s ../Application/views/flow/out/flow ../../out/flow
Option 2: Copying
out directory to shop:
cp -r flow/out/flow ../../out/flow
You now should be able to do
Step 5: Activate theme
Log into the admin panel, go to Extensions → Themes → Flow and press the Activate button. Clean the cache and off you go, my friend!
build directory. To regenerate the theme's assets, the
grunt tasks should be used. Please install
grunt and run
grunt's default task to regenerate all minimized
npmis required. Check
nodejswebsite for installation instructions (https://nodejs.org/en/download/package-manager/). Example of Installation on ubuntu system:
curl -sL https://deb.nodesource.com/setup_5.x | sudo -E bash - sudo apt-get install -y nodejs
sudo npm install -g grunt-cli
Go to "flow" theme's directory and install all related
cd DOCUMENT_ROOT/Application/views/flow/ sudo npm install
Now its possible to regenerate "flow" theme assets by running
gruntdefault task while being in "flow" directory:
If you are interested in contributing of some changes, Please read CONTRIBUTING.md file for more information.
Please forward all issues to https://bugs.oxid-esales.com/ for the project Flow Theme.
Licensing of the software product depends on the OXID eShop edition used. The software for OXID eShop Community Edition is published under the GNU General Public License v3. You may distribute and/or modify this software according to the licensing terms published by the Free Software Foundation. Legal licensing terms regarding the distribution of software being subject to GNU GPL can be found under http://www.gnu.org/licenses/gpl.html. The software for OXID eShop Professional Edition and Enterprise Edition is released under commercial license. OXID eSales AG has the sole rights to the software. Decompiling the source code, unauthorized copying as well as distribution to third parties is not permitted. Infringement will be reported to the authorities and prosecuted without exception.