feat: add readme
This commit is contained in:
68
README.md
Normal file
68
README.md
Normal file
@@ -0,0 +1,68 @@
|
||||
# MinIO Explorer
|
||||
|
||||
Application web simple pour explorer les fichiers d'un bucket MinIO, style "Index of" Apache.
|
||||
|
||||
## Fonctionnalités
|
||||
|
||||
- 🌐 **Navigation en lecture seule** dans l'arborescence MinIO
|
||||
- 🔍 **Prévisualisation** des fichiers (images, texte, markdown, PDF, vidéo, audio)
|
||||
- 📋 **Copie des liens directs** vers les ressources
|
||||
- 📱 **Interface responsive** (desktop et mobile)
|
||||
- ⚡ **Auto-configuration** depuis l'URL de déploiement
|
||||
- 🗂️ **Auto-ouverture** des fichiers index.rst
|
||||
|
||||
## Structure
|
||||
|
||||
```
|
||||
/
|
||||
├── index.html # Interface principale
|
||||
├── style.css # Styles responsive type "Index of"
|
||||
├── script.js # Logique de navigation et parsing XML
|
||||
├── CLAUDE.md # preuve de la flemme
|
||||
└── README.md # Ce fichier
|
||||
```
|
||||
|
||||
## Utilisation
|
||||
|
||||
### Déploiement
|
||||
|
||||
1. Placez les fichiers à la racine du bucket MinIO
|
||||
2. Configurez le bucket en lecture publique
|
||||
3. Activez CORS sur MinIO
|
||||
4. Accédez via `https://votre-minio.com/votre-bucket/index.html`
|
||||
|
||||
### Mode développement
|
||||
|
||||
L'interface inclut un formulaire pour tester différentes URLs MinIO directement depuis le navigateur.
|
||||
|
||||
## Prérequis MinIO
|
||||
|
||||
- Bucket accessible publiquement en lecture
|
||||
- Configuration CORS appropriée :
|
||||
```
|
||||
Access-Control-Allow-Origin: *
|
||||
Access-Control-Allow-Methods: GET
|
||||
Access-Control-Allow-Headers: *
|
||||
```
|
||||
|
||||
## Types de fichiers supportés
|
||||
|
||||
- **Images** : JPG, PNG, GIF, SVG, WebP...
|
||||
- **Texte/Code** : TXT, JSON, XML, HTML, JS, Python...
|
||||
- **Documentation** : Markdown (.md), reStructuredText (.rst)
|
||||
- **Médias** : PDF, MP4, MP3...
|
||||
|
||||
## Navigation
|
||||
|
||||
- Clic sur dossier → navigation
|
||||
- Clic sur fichier → prévisualisation
|
||||
- Bouton "Copier lien" → lien direct dans le presse-papier
|
||||
- Lien ".." → remontée dans l'arborescence
|
||||
|
||||
## Notes techniques
|
||||
|
||||
- **Frontend only** : HTML/CSS/JavaScript vanilla
|
||||
- **API MinIO** : Appels directs à l'API REST ListBucket
|
||||
- **Pas de serveur** : hébergé statiquement dans le bucket
|
||||
- **Historique navigateur** : navigation avec URL fragments (#/path)
|
||||
|
||||
Reference in New Issue
Block a user