Updated README and added LICENSE

This commit is contained in:
2025-01-23 18:49:37 +01:00
parent 15b106b7fd
commit 447d24dd11
2 changed files with 111 additions and 0 deletions

7
LICENSE Normal file
View File

@@ -0,0 +1,7 @@
Copyright 2025 Christian Nachtigall
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

104
README.md
View File

@@ -0,0 +1,104 @@
# Interaktiver Kalender (Vanilla JS)
## ✨ Projektbeschreibung
Ein interaktiver, dynamischer Kalender, der Nutzern das Verwalten von Terminen ermöglicht. Der Kalender bietet eine Monatsübersicht, lokale Speicherung von Terminen und optionale Erweiterungen wie wiederkehrende Ereignisse, Farbmarkierungen und Benachrichtigungen.
---
## 🌐 Demo
[Hier klicken, um die Anwendung zu sehen!](https://calendar.nachtigall.dev/)
---
## 🎨 Features
### Grundlegende Features
- Dynamische Monatsübersicht mit Tagberechnung basierend auf Monat und Jahr.
- Hinzufügen, Bearbeiten und Löschen von Terminen.
- Lokale Speicherung der Termine mittels `Indexed DB`.
- Markierung des aktuellen Tages.
### Erweiterte Features (optional)
- Wiederkehrende Ereignisse (täglich, wöchentlich, monatlich).
- Farbmarkierungen für unterschiedliche Kategorien (z. B. Arbeit, Freizeit, Geburtstage).
- Benachrichtigungen für bevorstehende Termine.
---
## 🔧 Technologien
- **HTML**: Struktur der Anwendung.
- **CSS**: Gestaltung und Layout.
- **Vanilla JavaScript**: Funktionalität und Logik.
- **Indexed DB**: Persistente Datenspeicherung.
---
## ⚖️ Installation und Ausführung
1. **Projekt klonen**:
```bash
git clone https://somegit.dev/vikingowl/Calendar.git
```
2. **Zum Projektordner wechseln**:
```bash
cd Calendar
```
3. **Index-Datei öffnen**:
- Öffne `index.html` in deinem Browser, um die Anwendung zu starten.
---
## 🌱 Entwicklungsanleitung
### 1. Monatsübersicht erstellen
- Dynamische Taggenerierung basierend auf Monat, Jahr und Tagesanzahl.
- Markiere den aktuellen Tag.
### 2. Terminmanagement
- Füge Funktionen hinzu, um Termine zu erstellen, zu bearbeiten und zu löschen.
- Speichere und lade Daten mit `Indexed DB`.
### 3. Erweiterungen (optional)
- Implementiere wiederkehrende Ereignisse und Benachrichtigungen.
- Nutze Farben, um Termine nach Kategorie zu kennzeichnen.
---
## 🔧 Verbesserungsmöglichkeiten
- Optimierung des Designs für Mobilgeräte (Responsive Layout).
- Integration von Benutzereinstellungen (z. B. Datumsformat oder Zeitzone).
- Weitere Sprachunterstützung (Internationalisierung).
---
## ✌️ Mitwirken
Beiträge sind willkommen!
1. Forke das Repository.
2. Erstelle einen neuen Branch:
```bash
git checkout -b feature/neues-feature
```
3. Mache deine Änderungen und committe:
```bash
git commit -m "Füge neues Feature hinzu"
```
4. Push den Branch:
```bash
git push origin feature/neues-feature
```
5. Erstelle einen Pull Request.
---
## 🔗 Links
- [Projektseite (Demo)](https://calendar.nachtigall.dev/)
- [Repository auf Gitea](https://somegit.dev/vikingowl/Calendar.git)
---
## © Lizenz
Dieses Projekt steht unter der [MIT-Lizenz](LICENSE).