Dokumentacja szablonu kalkulatora

Dokumentacja

⚠️

Dokumentacja jest w trakcie budowy, dlatego możesz nie znaleźć w niej informacji na niektóre zagadnienia.

Od czego zacząć

Jeśli dołączasz do projektu, przejdź dokumentację w tej kolejności:

  1. Instalacja – fork szablonu, Personal Access Token do rejestru @salesbook, instalacja pakietów.
  2. Uruchomienie projektu – komendy Nx uruchamiające kalkulator oraz podsumowania.
  3. Struktura projektu – podział na apps i libs oraz co gdzie trafia.
  4. Jak działa kalkulator – model mentalny całego modułu: przepływ danych, plik _app.tsx i integracja z Salesbookiem.
  5. Tutorial: pierwsza funkcjonalność – przejście przez wszystkie warstwy szablonu na jednym przykładzie: ustawienie, sekcja, krok, formuła, oferta, eksport.
  6. Kalkulator – najważniejsze elementy aplikacji: routing i flow kroków, store, ustawienia i providery.
  7. Elementy UI – komponenty, wrappery formularza, gotowe sekcje, ikony, layouty i motyw.
  8. Struktury plików – wzorce, według których pisze się kroki, sekcje i formuły obliczeniowe.
  9. Instrukcje – gotowe przepisy na dodanie kroku, sekcji, formuły, ustawienia, danych i tłumaczeń.
  10. Praktyki w projekcie – konwencje obowiązujące przy pisaniu kodu.

Jeśli wolisz uczyć się na konkretnym przykładzie zamiast czytać opis warstwa po warstwie, przejdź od razu do tutoriala — prowadzi przez pełną ścieżkę: ustawienie → sekcja → krok → formuła → wynik → oferta → eksport, a każdy etap kończy się instrukcją, jak sprawdzić, że działa.

Technologie

Uruchomienie projektu