docs: Add root README and Wiki documentation structure

This commit is contained in:
Toni Martin
2026-02-25 13:27:37 +01:00
parent ca0022e250
commit 974c93f305
5 changed files with 311 additions and 21 deletions

View File

@@ -1,38 +1,61 @@
# Office-Addin-TaskPane-React
# Cable Consolidation (Excel Add-In)
This repository contains the source code used by the [Yo Office generator](https://github.com/OfficeDev/generator-office) when you create a new Office Add-in that appears in the task pane. You can also use this repository as a sample to base your own project from if you choose not to use the generator.
Ein **Microsoft Excel Web-Add-In**, entwickelt von der SAT Elektrotechnik GmbH, zur intelligenten und effizienten Zusammenführung von Kabeldaten aus verschiedenen Tabellenblättern in eine formatierte "Kabelliste".
## TypeScript
![SAT Elektrotechnik](https://kabel.casademm.de/assets/icon-80.png)
This template is written using [TypeScript](http://www.typescriptlang.org/). For the JavaScript version of this template, go to [Office-Addin-TaskPane-React-JS](https://github.com/OfficeDev/Office-Addin-TaskPane-React-JS).
## 📖 Inhaltsverzeichnis
- [Features](#-features)
- [Technologie-Stack](#-technologie-stack)
- [Dokumentation & Wiki](#-dokumentation--wiki)
- [Schnellstart](#-schnellstart)
## Debugging
---
This template supports debugging using any of the following techniques:
## ✨ Features
Das Add-In optimiert den Planungsprozess durch folgende Funktionen:
- **Interne & Externe Quellen:** Konsolidiert Tabellenblätter aus der *aktuell geöffneten* Arbeitsmappe sowie aus *extern hochgeladenen* Excel-Dateien (`.xlsx`, `.xlsm`, `.csv`).
- **Intelligentes Mapping (Smart Aliasing):** Erkennt selbstständig die benötigten Spalten (z.B. "K-Nr.", "von", "nach Raum", etc.), auch wenn alternative Bezeichnungen (wie "Kabelnummer" oder "Nr.") verwendet werden.
- **Fehlertoleranz:** Leere Blätter, versteckte Blätter oder fehlende Kopfzeilen bringen das Add-In nicht zum Absturz. Der Benutzer kann fehlende Zuweisungen manuell vornehmen.
- **Saubere Ausgabe:** Die konsolidierten Daten werden automatisch als ansprechende, filterbare Excel-Tabelle generiert.
- [Use a browser's developer tools](https://learn.microsoft.com/office/dev/add-ins/testing/debug-add-ins-in-office-online)
- [Attach a debugger from the task pane](https://learn.microsoft.com/office/dev/add-ins/testing/attach-debugger-from-task-pane)
- [Use F12 developer tools on Windows 10](https://learn.microsoft.com/office/dev/add-ins/testing/debug-add-ins-using-f12-developer-tools-on-windows-10)
---
## Questions and comments
## 💻 Technologie-Stack
Das Projekt nutzt modernste Web-Technologien in Kombination mit Microsofts Add-In Architektur:
- **React (v18)** für die dynamische Benutzeroberfläche (Task Pane).
- **TypeScript** für typsichere Geschäftslogik.
- **Fluent UI (v9)** für ein nahtloses, Microsoft-natives Design.
- **Office.js API** zum direkten Lesen und Schreiben im Excel-Dokument.
- **SheetJS (xlsx)** zum clientseitigen Parsen von externen Dateien direkt im Browser-Speicher.
- **Webpack** als Build-Tool.
We'd love to get your feedback about this sample. You can send your feedback to us in the *Issues* section of this repository.
---
Questions about Office Add-ins development in general should be posted to [Microsoft Q&A](https://learn.microsoft.com/answers/questions/185087/questions-about-office-add-ins.html). If your question is about the Office JavaScript APIs, make sure it's tagged with [office-js-dev].
## 📚 Dokumentation & Wiki
## Join the Microsoft 365 Developer Program
Alle ausführlichen Leitfäden und Dokumentationen findest du im Ordner [`/docs`](./docs):
Join the [Microsoft 365 Developer Program](https://aka.ms/m365devprogram) to get resources and information to help you build solutions for the Microsoft 365 platform, including recommendations tailored to your areas of interest.
1. **[Architektur & Logik](./docs/01_Architektur.md)**: Erklärungen zur Code-Basis, den React-Komponenten und der Office.js Integration.
2. **[Entwickler-Setup](./docs/02_Entwicklung_Setup.md)**: Wie setze ich das Projekt lokal auf und entwickle weiter?
3. **[Benutzerhandbuch](./docs/03_Benutzerhandbuch.md)**: Die Schritt-für-Schritt Anleitung für die Endnutzer.
4. **[Deployment & Hosting](./docs/04_Deployment.md)**: Wie kommt das Tool auf den Ubuntu-Server und in das M365 Admin Center?
You might also qualify for a free developer subscription that's renewable for 90 days and comes configured with sample data; for details, see the [FAQ](https://learn.microsoft.com/office/developer-program/microsoft-365-developer-program-faq#who-qualifies-for-a-microsoft-365-e5-developer-subscription-).
---
## Additional resources
## 🚀 Schnellstart
- [Office Add-ins documentation](https://learn.microsoft.com/office/dev/add-ins/overview/office-add-ins)
- More Office Add-ins samples at [OfficeDev on Github](https://github.com/officedev)
Wenn du direkt in den Code einsteigen willst:
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
```bash
# Abhängigkeiten installieren
npm install
## Copyright
# Lokalen Entwicklungs-Server starten & Excel Add-In Sideloaden
npm start
Copyright (c) 2021 Microsoft Corporation. All rights reserved.
# Produktions-Build erstellen
npm run build
```
*Entwickelt mit ❤️ für eine effizientere Kabelplanung.*