[inhalt]
Projekt BISO 3 - Handbuch

Projektstruktur, Repository

Repository

BISO ist als GIT-Repository auf unserem internen Reposerver zu finden:

https://gitlab.kadenpartner.ch/kp/biso.git

Clone mit:

git clone https://gitlab.kadenpartner.ch/kp/biso.git

Projektstruktur

Die Verzeichnis- resp. Projektstruktur ist wie folgt definiert:

biso/
|-- Gruntfile.js                    # Grunt-Task-Konfiguration
|-- doc/                            # Projektdokumentation
|    |-- api-doc                    #   Swagger API-Doc
|    |-- handbuch/                  #   Entwicklungs- und Betriebshandbuch
|    |-- infopage/                  #   Infopage für biso.kadenpartner.ch
|    +-- db/                        #   Datenbank-Dokumentation
|-- docker/                         # Docker
|    |-- dev/                       #   Dockerfile für die Entwicklungsumgebung
|    +-- prod/                      #   Dockerfile für die Produktionsumgebung
|-- integration/                    # Alles rund um die Sofware-Integration
|    |-- changelog-archive/         #   beinhaltet alle Tag-Changelogs
|    |-- sql-archive/               #   beinhaltet alle Tag-SQL-Migrationsscripts
|    |-- tag-changelog.md           #   Das Changelog des aktuellen Branch HEAD, wird beim Taggen in changelog_archive kopiert
|    +-- tag-migration.sql          #   Das SQL des aktuellen Branch HEAD, wird beim Taggen in sql_archive kopiert
|-- node_modules/                   # lokale Node-Module, von npm installiert
|-- package.json                    # npm-Paket-Konfiguration
+-- webroot/                        # DAS Webroot, die eigentliche Applikation, welche beim Kunden landet
     |-- app/                       # ExtJS-Applikation, beinhaltet allen ExtJS-Projektcode
     |-- backend/                   # PHP-Backend, projektspezifische Controller, Entities etc, basiert auf Gaia
     |-- build/                     # für Release-Build
     |-- components/                # externe Libraries
     |    |-- gaia/                 #    Unser hausinternes PHP-Backend
     |    +-- extjs/                #    ExtJS selber
     |-- config.php                 # Die Projektkonfiguration, nicht Teil vom Repo. config.orig.php kopieren.
     |-- db_migrations/             # Speicherort aller DB-Migrationen über gaia migration
     |-- index.php                  # Das Startfile für die Applikation, im eingeloggten Zustand
     |-- login.php                  # Das Startfile für die Applikation, im ausgeloggten Zustand
     |-- lang/                      # Sprachdateien, Übersetzungen
     |    |-- de_ch.json               # Deutsche Sprachdaten
     |    |-- fr_ch.json               # Deutsche Sprachdaten
     |    +-- customers/               # kundenspezifische Sprachdaten
     |-- packages/                  # Sencha Packages
          +-- poseidon/             # Das BISO 2-Thema, erbt von ext-theme-neptune
     |-- resources/                 # statische Web-Resourcen wie Bilder etc.
     +-- version.txt                # aktuelle Versionsnumer

Projekt-Setup

  1. Setup der eigenen Build-Infrastruktur (siehe Entwicklungs- und Buildtools)
  2. git clone wie oben
  3. cd biso/
  4. npm run setup-dev
  5. webroot/config.php anpassen