https://github.com/dev-jan/sap-commerce-backoffice-icons
Simple Tool to create explorer tree icons for the SAP Commerce Backoffice interface
https://github.com/dev-jan/sap-commerce-backoffice-icons
backoffice hacktoberfest hybris hybris-commerce-suite icons sap sapcommerce
Last synced: about 2 months ago
JSON representation
Simple Tool to create explorer tree icons for the SAP Commerce Backoffice interface
- Host: GitHub
- URL: https://github.com/dev-jan/sap-commerce-backoffice-icons
- Owner: dev-jan
- License: mit
- Created: 2020-11-04T19:55:10.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-01-18T19:11:52.000Z (over 4 years ago)
- Last Synced: 2026-04-04T10:58:46.829Z (about 2 months ago)
- Topics: backoffice, hacktoberfest, hybris, hybris-commerce-suite, icons, sap, sapcommerce
- Language: Python
- Homepage:
- Size: 72.3 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SAP Commerce Cloud Backoffice icon converter
Simple Tool to create explorer tree icons for the SAP Commerce Backoffice
interface from simple icon files.
## Why is this needed?
The SAP Commerce Cloud Backoffice interface requires a special crafted sprite
image to show it as icon in the explorer tree. This tool helps creating this
sprites based on a simple icon file.
## How to use it?
The simplest case is to convert a single icon. For this you must have an input
icon meeting the following criterias:
- Size is 16x16 pixels (given by SAP Commerce)
- Transparent background (otherwise it will not really work)
- File format should be "png"
Run the following commands to create the sprite (replace the example icon with
your own):
```sh
$ pip install sap-commerce-backoffice-icons
$ backofficeIconConverter exampleIcons/star.png
Process icon exampleIcons/star.png...
exampleIcons/star.png => exampleIcons/backoffice-star.png
```
That's it! Now you can use this icon sprite in your custom Backoffice extension
as icon for your custom types. For more help on how to do this, see
[Tutorial](doc/Tutorial.md).
You can also convert multiple icons:
```
$ backofficeIconConverter ~/FolderWithSomeIcons/* --output converted
```
## Install development environment
To install the script for development or to run it directly from source, the following
steps are needed:
- Install Python >3.7
- Install Poetry (see https://python-poetry.org/docs/)
- Make the project ready to be used:
```sh
git clone https://github.com/dev-jan/sap-commerce-backoffice-icons.git
cd sap-commerce-backoffice-icons
poetry install
```
- Run the script via Poetry virtual env:
```sh
poetry run backofficeIconConverter exampleIcons/star.png
```