diff --git a/README.md b/README.md index a6f43de..387d141 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,61 @@ -# git_test +# Git Test — Static Site & PocketBase Demo -First commit — initial repository setup. +Kurzes Beispielprojekt mit einer einfachen Node/Express-Server-API, statischen Dateien im Ordner `public` und einer Docker-Compose-Konfiguration zum schnellen Starten. -## Overview -This repository contains the starter files for the project. +## Inhalt des Repositories -## Getting started -1. Clone the repo: - ``` - git clone - ``` -2. Open the project: - ``` - cd git_test - ``` +- **server.js** — Node-Server zum Bereitstellen der statischen Dateien. +- **public/** — Frontend-Dateien (HTML, JS, CSS, Assets). Enthält Beispiele wie `index.html`, `networktester.html`, `wlan.html` u.v.m. +- **lib/** — Hilfs-Skripte und Third-Party-Bundles (z. B. `pocketbase.umd.js`). +- **Dockerfile**, **docker-compose.yml** — Container-Setup für lokalen Betrieb oder Deployment. -## Contributing -1. Create a branch: `git checkout -b feat/your-feature` -2. Commit changes: `git add . && git commit -m "Describe changes"` -3. Push and open a pull request. +## Voraussetzungen + +- Node.js (>= 18 empfohlen) +- npm oder yarn +- Optional: Docker & Docker Compose zum Container-basierten Start + +## Lokal starten (Node) + +1. Abhängigkeiten installieren (falls notwendig): + +```bash +npm install +``` + +2. Server starten: + +```bash +node server.js +# oder: npm start (falls im package.json konfiguriert) +``` + +Öffne dann `http://localhost:3000` (oder den in `server.js` konfigurierten Port). + +## Mit Docker Compose starten + +```bash +docker compose up --build +``` + +Die Compose-Konfiguration startet den Webserver (und optional weitere Dienste). + +## Entwicklung + +- Frontend-Dateien liegen im Ordner `public/`. Änderungen dort werden direkt vom Server ausgeliefert. +- Kleine Hilfsskripte und Libs befinden sich in `public/lib/`. +- Für schnelle Tests öffne die passenden HTML-Dateien im Browser oder rufe die App über den lokalen Server auf. + +## Hinweise + +- Dieses Repo ist als leichtes Demo-/Testprojekt organisiert und nicht als produktive Anwendung gedacht. +- `pocketbase.umd.js` liegt in `public/lib/` bereit — entferne oder konfiguriere diesen Bestandteil entsprechend, falls du PocketBase nutzt. + +## Lizenz + +Standardmäßig keine Lizenz. Füge bei Bedarf eine `LICENSE`-Datei hinzu. + +## Kontakt + +Bei Fragen oder Änderungswünschen beschreibe kurz, was du brauchst — ich helfe gern weiter. -## License -Add a LICENSE file or specify a license here. \ No newline at end of file