frontend-guide

# Spis treści

  1. Informacje ogólne
    1. Informacje ogólne na temat akeneo
  2. Konfiguracja środowiska
    1. Pobranie repozytorium i instalacja
    2. Ustawienia połączenia
    3. Dodanie remote hosta
    4. Ustawienie automatycznego dyploymentu
    5. Podstawowe informacje o workflow i strukturze plików
  3. Budowa frontendu
    1. Nadpisywanie modułu własnym modułem
    2. Dodawanie własnych plików i wykorzystanie ich w istniejących modułach
    3. Rozszerzanie istniejących modułów
    4. Przesyłanie wiadomości za pomocą mediatorów
    5. UserContext
    6. LocaleReference, ChannelReference
    7. Tłumaczenia
    8. Select2 - podstawowe zagadniania
    9. Select2 - record select field
    10. Select Field
  4. REST API w akeneo
    1. Wykorzystanie Fetchera do wykonywania zapytań
    2. Pobieranie danych
    3. Modyfikowanie danych

# 1. Informacje ogólne

Krótki opis czym akeneo jest i do czego służy.

# 2.Konfiguracja środowiska

# 2.1. Pobranie repozytorium i instalacja paczek

Jak pobrać repozytorium i zainstalować wymagane paczki

# 2.2. Ustawienia połączenia

Ustawienie połączenia z serwerem na którym znajduję się akeneo. Konfiguracja SFTP, root patha oraz konfiguracji ssh.

# 2.3. Dodanie remote hosta

Ustawienie remote Hosta w php stormie, tak aby można było przeglądać pili z serwera w edytorze.

# 2.4. Ustawienie automatycznego dyploymentu

Ustawienie automatycznego dyploymentu na serwer po zapisaniu zmian w edytowanym pliku.

# 2.5. Podstawowe informacje o workflow i strukturze plików

Informacje o tym gdzie znajdują się pliki akeneo, gdzie tworzyć nowe moduły oraz podstawowe komendy.

# 3. Budowa frontendu

# 3.1. Nadpisywanie modułu własnym modułem

Jak napisać istniejący plik, gdzie go szukać oraz jak podpiąć za pomocą require.js.

# 3.2. Dodawanie własnych plików i wykorzystanie ich w istniejących modułach

Jak dodać własny pilik javascript, jak go zaincludować do instniejącego modułu. Przesyłanie informacji między komponentami javascriptowymi.

# 3.3. Rozszerzanie istniejących modułów

Jak unikać nadpisywania całych kompoentów kiedy chcemy zmodyfikować tylko jedną metodę. Jak zapimortować w plikich yml pierwotny oraz extendowany plik.

# 3.4. Przesyłanie wiadomości za pomocą mediatorów

Kiedy można skorzystać z pomocy mediatorów, jak wysłać wiadomość oraz ją oderać. Jakie są jego ograniczenia.

# 3.5 UserContext

UserContext - wybrane funkcje i przykładu kodu.

# 3.6 LocaleReference, ChannelReference

LocaleReference, ChannelReference - wybrane funkcje i przykłady.

# 3.7. Tłumaczenia

Dodawanie tłumaczeń na front-endzie.

# 3.8. Select2

Podstawowe informacje na temat selecta2, o jego konfiguracji oraz zasadzie działania.

# 3.9. Select2 - record select field

Podstawowe informacje Record select field oraz jego przykład na przykładzie selecta do wyboru paczek. Zasada działanie, pliki, metody oraz kod źródłowy.

# 3.10. Select Field

Inny typ selecta używany w akeneo bez wykorzystanie biblioteki select2.

# 4. REST API w akeneo

# 4.1. Wykorzystanie Fetchera do wykonywania zapytań

Wykorzystanie Fetchera do wykonywania zapytań dla różnego typu danych i grup. Przykłady użycia i otrzymanych odpowiedzi.

# 4.2. Pobieranie danych

Prosty przykład pobierania danych a api dla frontu zbudowanego na reakcie w akeneo.

# 4.3. Modyfikowanie danych

Prosty przykład tworzenie paczki za pomocą POST'a dla frontu zbudowanego na reakcie w akeneo.