https://github.com/n516942r/neocardium
NeoCardium – Die moderne Karteikarten App für Windows 11
https://github.com/n516942r/neocardium
education sqlite windows-app winui3
Last synced: 2 months ago
JSON representation
NeoCardium – Die moderne Karteikarten App für Windows 11
- Host: GitHub
- URL: https://github.com/n516942r/neocardium
- Owner: N516942R
- License: mit
- Created: 2025-02-26T18:53:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-16T08:21:51.000Z (about 1 year ago)
- Last Synced: 2025-09-06T08:56:25.042Z (11 months ago)
- Topics: education, sqlite, windows-app, winui3
- Language: C#
- Homepage:
- Size: 179 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
README
Hier ist eine **strukturierte und professionelle `README.md`** für dein **NeoCardium**-Projekt mit **WinUI 3 und SQLite**:
---
# **📌 NeoCardium – Die moderne Karteikarten-App für Windows 11**
🚀 **Lernmanagement mit WinUI 3 & SQLite**
---
## **📖 Inhaltsverzeichnis**
- [📌 Einführung](#-einführung)
- [✨ Features](#-features)
- [🛠 Technologie-Stack](#-technologie-stack)
- [🚀 Installation](#-installation)
- [📂 Projektstruktur](#-projektstruktur)
- [📜 Changelog](#-changelog)
- [📢 Roadmap](#-roadmap)
- [📝 Lizenz](#-lizenz)
- [🤝 Pull-Request](#-pull-request)
---
## **📌 Einführung**
**NeoCardium** ist eine moderne **Karteikarten-App für Windows 11**, die mit **WinUI 3, .NET 6/7 und SQLite** entwickelt wurde.
Sie ermöglicht ein effizientes Lernen durch **Multiple-Choice-Antworten, eine smarte Statistikfunktion und eine intuitive Benutzeroberfläche**.
Ob zum **Sprachen lernen, für Prüfungen oder einfach zur Wissenserweiterung** – NeoCardium hilft dir, effizienter zu lernen!
---
## **✨ Features**
✅ **Erstellung & Verwaltung von Karteikarten**
✅ **Multiple-Choice-Antworten & Kategorisierung**
✅ **Intuitive WinUI 3-Oberfläche mit Fluent Design**
✅ **SQLite-Datenbank zur Speicherung deiner Lernkarten**
✅ **Statistiken zur Lernanalyse** (Anzahl richtige/falsche Antworten)
✅ **Dunkelmodus & modernes Design für Windows 11**
✅ **Self-Contained EXE ohne Installation lauffähig**
---
## **🛠 Technologie-Stack**
NeoCardium wurde mit folgenden Technologien entwickelt:
| **Technologie** | **Beschreibung** |
|-----------------|----------------|
| 🖥 **WinUI 3** | Moderne Windows-UI mit Fluent Design |
| 🏗 **.NET 6/7** | Leistungsstarke .NET-Laufzeitumgebung |
| 💾 **SQLite** | Schnelle, lokale Datenbank für Offline-Nutzung |
| 🏛 **MVVM** | Saubere Architektur für bessere Wartung |
| 📦 **Windows App SDK** | Moderne Windows-App-Entwicklung |
---
## **🚀 Installation**
### **🔹 Voraussetzungen**
📌 **Windows 11**
📌 **.NET 6/7 SDK** (falls du das Projekt selbst kompilieren möchtest)
### **🔹 Option 1: Portable EXE (Empfohlen)**
1. Lade die neueste **Release-Version** [📥 hier](#) herunter.
2. Entpacke das ZIP-Archiv an einen beliebigen Ort.
3. **Doppelklick auf `NeoCardium.exe`**, um die App zu starten! ✅
### **🔹 Option 2: Manuelle Installation (Entwicklermodus)**
Falls du die App selbst kompilieren möchtest:
```sh
git clone https://github.com/Stauber-Justin/NeoCardium.git
cd NeoCardium
dotnet build -c Release
dotnet run
```
---
## **📂 Projektstruktur**
Das Projekt ist nach dem **MVVM-Pattern** strukturiert:
```plaintext
📂 NeoCardium
┣ 📂 Models # Datenmodelle (z. B. Flashcard)
┣ 📂 ViewModels # MVVM-Logik (Datenverwaltung)
┣ 📂 Views # XAML-Dateien (UI)
┣ 📂 Services # Datenbank- und Geschäftslogik
┣ 📂 Helpers # UI-Hilfsfunktionen (Converter, Formatierer)
┣ 📂 Assets # Icons, SplashScreens
┣ 📜 App.xaml # Globale Ressourcen und Stile
┣ 📜 MainWindow.xaml # Hauptfenster der Anwendung
┣ 📜 README # Diese Datei 😉
┣ 📜 CHANGELOG # Vollständiger Changelog
┗ 📜 LICENSE # MIT-Lizenz*
```
---
## **📦 Veröffentlichung im Microsoft Store**
Nutze das GitHub Actions-Workflow **Build MSIX Package**, um ein
signierbares MSIX-Paket zu erzeugen:
```sh
dotnet publish NeoCardium/NeoCardium.csproj -c Release -p:WindowsPackageType=MSIX -p:GenerateAppxPackageOnBuild=true
```
1. Lade das Workflow-Artefakt herunter.
2. Signiere das Paket mit deinem Zertifikat.
3. Lade das signierte MSIX im [Microsoft Partner Center](https://partner.microsoft.com/) hoch.
---
## **📜 Changelog**
### **Version 1.0.0 – Erste stabile Version**
- 🚀 **MVP mit SQLite & WinUI 3 fertiggestellt**
- 🆕 **Such- & Filterfunktionen für Flashcards**
- 🎨 **Dunkelmodus & modernes Windows 11 Design**
- 🛠 **Bugfixes & Performance-Optimierungen**
**[📜 Vollständiger Changelog](./CHANGELOG)**
---
## **📢 Roadmap**
📌 **Geplante Features für zukünftige Versionen:**
- 📊 **Erweiterte Statistik- & Analysefunktionen**
- ☁ **Cloud-Synchronisation (OneDrive, Google Drive)**
- 🎯 **Lernmodus mit Tageszielen & Erinnerungen**
- 📱 **Mobile App-Version für Android & iOS**
Falls du Vorschläge hast, erstelle gerne ein **Issue** oder einen **Pull Request**! 🤝
---
## **📝 Lizenz**
📜 **MIT-Lizenz** – freie Nutzung, Veränderung & Verbreitung erlaubt.
[🔗 Lizenzdetails anzeigen](./LICENSE)
---
## **🤝 Pull Request**
💡 **Hast du Ideen für Verbesserungen?**
Wir freuen uns über **Pull Requests & Feature-Ideen**! 🎉
### **💻 So trägst du zum Projekt bei:**
1️⃣ **Forke das Repository**
2️⃣ **Erstelle einen Branch für deine Änderung** (`git checkout -b feature-meine-idee`)
3️⃣ **Führe deine Änderungen durch & committe sie** (`git commit -m "Feature hinzugefügt"`)
4️⃣ **Erstelle einen Pull Request** und wir schauen uns deine Änderung an! 🚀
🙌 Vielen Dank für deinen Support!
---
**📧 Kontakt & Support**
Falls du Fragen hast oder auf Probleme stößt, erstelle bitte ein **GitHub Issue**.
🚀 Viel Spaß mit **NeoCardium** & viel Erfolg beim Lernen! 💡🎯