Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/oxid-esales/wave-theme

The Wave theme for OXID eShop
https://github.com/oxid-esales/wave-theme

grunt html oxid-eshop sass smarty theme

Last synced: 26 minutes ago
JSON representation

The Wave theme for OXID eShop

Awesome Lists containing this project

README

        

# Wave Theme

## General Information

*Wave* is a responsive Smarty theme for all OXID eShop editions.
This theme replaces deprecated [Flow theme](https://github.com/OXID-eSales/flow_theme).

## Branch Compatibility

* `b-7.0.x` is compatible with OXID eShop compilation `b-7.0.x`
* `b-6.5.x` is compatible with OXID eShop compilation `b-6.5.x`

## Installation
If you want to extend the theme you need to clone the repository (see section development) as some sources are ignored on composer installation.

### Step 1: Get the source code

This step is only required if the theme is not delivered with the OXID distribution.
```
composer require oxid-esales/wave-theme
```

### Step 2: Activate theme

Log into the admin panel, go to *Extensions → Themes → Wave* and press the *Activate* button. Clean the cache and off you go!

## Development

All *Wave* 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:

To get the development files you need to clone the repository

cd DOCUMENT_ROOT/Application/views/
git clone -b BRANCH_NAME https://github.com/OXID-eSales/wave-theme.git wave

1. 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:

```
curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
sudo apt-get install -y nodejs
```

2. Go to "wave" theme's directory and install all related ``grunt`` plugins:

```
cd DOCUMENT_ROOT/Application/views/wave/
npm install
```

3. Now its possible to regenerate "wave" theme assets by running ``grunt`` default
task while being in "wave" directory:

```
npm start
```

## Contributing

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

## Issues

Please forward all issues to https://bugs.oxid-esales.com/ for the project **Wave Theme**.