first
This commit is contained in:
47
README.md
Normal file → Executable file
47
README.md
Normal file → Executable file
@@ -1,2 +1,47 @@
|
||||
# mqtt_explorer
|
||||
|
||||
# MQTT Web Explorer - Monokai Pro
|
||||
|
||||
Interface web moderne pour l'exploration de brokers MQTT avec backend persistant en Go.
|
||||
|
||||
## Caractéristiques
|
||||
- **Backend Go**: Connexion continue même quand l'onglet est fermé.
|
||||
- **SQLite**: Historique complet des messages stocké localement.
|
||||
- **UI Monokai**: Thème sombre haute fidélité pour les développeurs.
|
||||
- **Explorateur CLI**: Arbre hiérarchique intelligent avec filtres regex.
|
||||
- **Payload Intelligent**: Détection automatique de JSON et Images Base64.
|
||||
- **Responsive**: Compatible Desktop, Tablette et Mobile.
|
||||
|
||||
## Lancement rapide
|
||||
|
||||
### Via Docker (Recommandé)
|
||||
```bash
|
||||
docker compose up -d --build
|
||||
```
|
||||
L'application sera disponible sur `http://localhost:8088`.
|
||||
|
||||
### Développement local (Backend)
|
||||
```bash
|
||||
cd backend
|
||||
go run ./cmd/server
|
||||
```
|
||||
|
||||
### Développement local (Frontend)
|
||||
```bash
|
||||
cd frontend
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
## Structure du projet
|
||||
- `backend/`: Serveur Go (Gin + Paho MQTT + SQLite).
|
||||
- `frontend/`: Client React (Tailwind + Lucide + Vite).
|
||||
- `doc/`: Analyses détaillées et documentation technique.
|
||||
- `docker-compose.yml`: Orchestration des services (Mosquitto + App).
|
||||
|
||||
## Configuration
|
||||
Les variables d'environnement suivantes peuvent être configurées :
|
||||
- `MQTT_BROKER`: URL du broker (default: tcp://broker.hivemq.com:1883)
|
||||
- `SQLITE_DB`: Chemin de la DB (default: ./data/mqtt.db)
|
||||
- `TTL_DAYS`: Durée de conservation des messages (default: 7)
|
||||
- `MQTT_SUBSCRIBE`: Topic de souscription par défaut (default: #)
|
||||
- `MQTT_QOS`: QoS par défaut (default: 0)
|
||||
|
||||
Reference in New Issue
Block a user