chore: normalize line endings + remove old reservation-platform
This commit is contained in:
@ -1 +1,51 @@
|
||||
|
||||
# Aufräumarbeiten MYP-Projekt (19.05.2025)
|
||||
|
||||
## Durchgeführte Änderungen
|
||||
|
||||
### Verzeichnisstruktur
|
||||
|
||||
- Skriptdateien in logische Kategorien reorganisiert:
|
||||
- `scripts/setup/`: Einrichtungsskripte
|
||||
- `scripts/deployment/`: Bereitstellungsskripte für Raspberry Pi
|
||||
- Neue Verzeichnisse erstellt:
|
||||
- `logs/`: Für Fehlerprotokolle und Logdateien
|
||||
- `config/secure/`: Für sensible Konfigurationsdaten
|
||||
|
||||
### Dokumentation
|
||||
|
||||
- Zentrale `Dokumentation.md` aktualisiert und erweitert
|
||||
- Entwicklungsrichtlinien von `CLAUDE.md` nach `docs/Entwicklungsrichtlinien.md` verschoben
|
||||
- README.md korrigiert und Git-Konfliktmarkierungen entfernt
|
||||
|
||||
### Sicherheit
|
||||
|
||||
- Sensible Daten (CREDENTIALS) in `config/secure/` verschoben
|
||||
- `.gitignore` aktualisiert, um sensible Dateien und temporäre Dateien auszuschließen
|
||||
|
||||
### Dateiorganisation
|
||||
|
||||
- Fehlerlogs in `logs/` verschoben
|
||||
- Temporäre Dateien bereinigt
|
||||
- Skript-Dateien in sinnvolle Kategorien einsortiert
|
||||
|
||||
## Projektstruktur nach Aufräumarbeiten
|
||||
|
||||
```
|
||||
Projektarbeit-MYP/
|
||||
├── backend/ # Flask-Backend
|
||||
├── config/
|
||||
│ └── secure/ # Sensible Konfigurationen
|
||||
├── docs/ # Projektdokumentation
|
||||
├── frontend/
|
||||
├── logs/ # Fehlerprotokolle
|
||||
└── scripts/
|
||||
├── deployment/ # Raspberry Pi Deployment
|
||||
└── setup/ # Einrichtungsskripte
|
||||
```
|
||||
|
||||
## Empfehlungen für zukünftige Arbeiten
|
||||
|
||||
- Gemeinsames Datenbankmodell zwischen Backend und Frontend überarbeiten
|
||||
- Weitere Dokumentation der API-Schnittstellen erstellen
|
||||
- Testabdeckung erhöhen
|
||||
- Deployment-Prozess automatisieren
|
||||
|
@ -1,44 +1,49 @@
|
||||
# MYP Project Development Guidelines
|
||||
|
||||
## System Architecture
|
||||
- **Frontend**:
|
||||
- Located in `packages/reservation-platform`
|
||||
|
||||
- **Frontend**:
|
||||
|
||||
- Located in `frontend`
|
||||
- Runs on a Raspberry Pi connected to company network
|
||||
- Has internet access on one interface
|
||||
- Connected via LAN to an offline network
|
||||
- Serves as the user interface
|
||||
- Developed by another apprentice as part of IHK project work
|
||||
|
||||
- **Backend**:
|
||||
|
||||
- Located in `backend` directory
|
||||
- Flask application running on a separate Raspberry Pi
|
||||
- Connected only to the offline network
|
||||
- Communicates with WiFi smart plugs
|
||||
- Part of my IHK project work for digital networking qualification
|
||||
|
||||
- **Printers/Smart Plugs**:
|
||||
|
||||
- Printers can only be controlled (on/off) via WiFi smart plugs
|
||||
- No other control mechanisms available
|
||||
- Smart plugs and printers are equivalent in the system context
|
||||
|
||||
## Build/Run Commands
|
||||
|
||||
- Backend: `cd backend && source venv/bin/activate && python app.py`
|
||||
- Frontend: `cd packages/reservation-platform && pnpm dev`
|
||||
- Frontend: `cd frontend && pnpm dev`
|
||||
- Run tests: `cd backend && python -m unittest development/tests/tests.py`
|
||||
- Run single test: `cd backend && python -m unittest development.tests.tests.MYPBackendTestCase.test_name`
|
||||
- Check jobs manually: `cd backend && source venv/bin/activate && flask check-jobs`
|
||||
- Lint frontend: `cd packages/reservation-platform && pnpm lint`
|
||||
- Format frontend: `cd packages/reservation-platform && npx @biomejs/biome format --write ./src`
|
||||
- Lint frontend: `cd frontend && pnpm lint`
|
||||
- Format frontend: `cd frontend && npx @biomejs/biome format --write ./src`
|
||||
|
||||
## Code Style
|
||||
|
||||
- **Python Backend**:
|
||||
|
||||
- Use PEP 8 conventions, 4-space indentation
|
||||
- Line width: 100 characters max
|
||||
- Add docstrings to functions and classes
|
||||
- Error handling: Use try/except with specific exceptions
|
||||
- Naming: snake_case for functions/variables, PascalCase for classes
|
||||
|
||||
- **Frontend (Next.js/TypeScript)**:
|
||||
|
||||
- Use Biome for formatting and linting (line width: 120 chars)
|
||||
- Organize imports automatically with Biome
|
||||
- Use TypeScript types for all code
|
||||
@ -46,8 +51,9 @@
|
||||
- Naming: camelCase for functions/variables, PascalCase for components
|
||||
|
||||
## Work Guidelines
|
||||
|
||||
- All changes must be committed to git
|
||||
- Work efficiently and cost-effectively
|
||||
- Don't repeatedly try the same solution if it doesn't work
|
||||
- Create and check notes when encountering issues
|
||||
- Clearly communicate if something is not possible so I can handle it manually
|
||||
- Clearly communicate if something is not possible so I can handle it manually
|
||||
|
Reference in New Issue
Block a user