Get-capitan NPM

capitan

Capitan is a Grunt-based, system independent Frontend-Workflow that builds on a flexible component system.

The main features are:

System independent
Components are self-contained
Separation between private and public assets

Die Projektstruktur

Bevor im Detail auf die einzelnen Bereiche eines Projekts eingegangen wird, gibt es ein grundlegendes Prinzip, dass jedem Projekt zu Grunde liegt, welches auf Basis des Workflows erstellt wurde. Es gibt immer einen Private- und einen Public-Bereich, unabhängig vom jeweiligen System (Typo3, Zend, o.ä.). Im Private-Bereich befinden sich alle Quell-Dateien, angefangen bei JS-, über SCSS- bis hin zu TPL-Dateien, die nur für die Entwicklung gedacht sind und nichts in einer Live-Umgebung zu suchen haben. Jegliche Änderungen/Anpassungen/Erweiterungen finden im Private-Bereich des Projekts statt. Ausgenommen davon sind Font-Dateien oder Grafiken. Diese werden direkt im Public-Bereich in den dafür vorgesehenen Ordnern abgelegt. Alle anderen Dateien werden automatisiert über den Workflow im richtigen Format in den dafür vorgesehenen Ordnern abgelegt.

In der folgenden Tabelle werden die wichtigsten Ordner und Funktionen im Private-Bereich vorgestellt.

component
   |- [custom component]
js
   |- function
   |- handle
   |- util
   |- libs
      |- vendor
         |- [vendor scripts]
sass
   |- partials
   |- vendor
      |- bootstrap
templates
   |- tpl
      |- partials