oxid-esales/flow-theme

Tuesday, July 31, 2018
by oxid
Repository
31 Watchers
24 Stars
38,710 Installations

Smarty
3 Dependents
0 Suggesters
42 Forks
20 Open issues
39 Versions
17 % Grown

The README.md

Flow Theme

General Information

Flow is a responsive theme for all OXID eShop editions., _(*1)

Warning! Flow theme is depreciated. See also Wave Theme and Graph QL Api for alternatives., _(*2)

Installation

Step 1: Select the appropriate branch

Branch b-3.x contains Flow for OXID eShop compilation 6.3 and 6.4
Branch master contains Flow for OXID eShop master branch's latest commits

Step 2: Get the source code

Check out the appropriate branch for your OXID eShop version into the shop's Application/views directory:, _(*3)

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 DOCUMENT_ROOT/Application/views/flow., _(*4)

Step 3: Prepare the `out` folder

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

Option 1: Symbolic Linking

Link the theme's out directory to the out directory of the shop:, _(*6)

ln -s ../Application/views/flow/out/flow ../../out/flow, _(*7)

Option 2: Copying

Copy theme's out directory to shop:, _(*8)

cp -r flow/out/flow ../../out/flow, _(*9)

You now should be able to do cd ../../out/flow., _(*10)

Step 4: 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!, _(*11)

Development

All Flow theme related CSS/Javascript files can be found in theme's 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 css and js files:, _(*12)

To get the development files you need to clone the repository., _(*13)

To use grunt, npm is required. Check nodejs website for installation instructions (https://nodejs.org/en/download/package-manager/). Example of Installation on ubuntu system:, _(*14)
```
curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
sudo apt-get install -y nodejs
```
Install grunt globally and update npm. Example:, _(*15)
```
sudo npm install -g npm grunt-cli 
```
Go to "flow" theme's directory and install all related grunt plugins:, _(*16)
```
cd DOCUMENT_ROOT/Application/views/flow/
npm install
```
Now its possible to regenerate "flow" theme assets by running grunt default task while being in "flow" directory:, _(*17)
```
grunt
```

Contributing

If you are interested in contributing of some changes, Please read CONTRIBUTING.md file for more information., _(*18)

Distribution notice

The Flow Theme will not be shipped with the next major release of OXID eShop (>6) as it is using older components! Please consider to use the Wave Theme., _(*19)

Issues

Please forward all issues to https://bugs.oxid-esales.com/ for the project Flow Theme., _(*20)

The Versions

31/07 2018

oxideshop-theme flow-theme

oxid-esales/flow-theme

The README.md

Flow Theme

General Information

Installation

Step 1: Select the appropriate branch

Step 2: Get the source code

Step 3: Prepare the out folder

Option 1: Symbolic Linking

Option 2: Copying

Step 4: Activate theme

Development

Contributing

Distribution notice

Issues

The Versions

dev-remove_unnecessary_lang_idents

dev-rename_tests

dev-show_errors_with_destination_popup

dev-master

v3.0.2

dev-pull-request

dev-b-1.0

v3.0.1

dev-change_username_OXDEV-29

dev-pr105

v3.0.0

dev-fix_template_blocks_debug

dev-b-6.x-dsgvo_delete_user_account-OXDEV-800

v1.0.0-beta

v1.0.0-beta.2

dev-master-manage_product_reviews-OXDEV-802

dev-hint_improve-OXDEV-786

dev-b-2.x

dev-compare_links_in_lists_do_not_work_correctly-OXDEV-605

v2.3.3

dev-guestbook_option_remains_in_footer_settings-OXDEV-317

v2.3.2

dev-revert-84-master.6588.price_alert_translation

dev-pr54

v2.3.1

dev-private-master-delete_setup-OXDEV-491-backup

dev-master-update_usages_of_version_number-ESDEV-4411

v2.3.0

v2.2.1

v1.0.1

dev-composer_filter-ESDEV-4443

v2.2.0

v2.1.0

dev-master-cookie_note_position-ESDEV-4212

dev-theme-settings-ESDEV-3851

v2.0.0

v1.0.0

dev-master__show_errors_with_destination_popup

dev-extract_tags_feature_into_contrib_module-ESDEV-3419

Step 3: Prepare the `out` folder