enhance README with emojis and panafricanist vision
This commit is contained in:
@@ -1,36 +1,38 @@
|
|||||||
# kaubuntu.re - Plateforme Multimédia
|
# 🎬 kaubuntu.re - Plateforme Multimédia
|
||||||
|
|
||||||
Une plateforme multimédia conçue pour diffuser du contenu à partir d'une instance PeerTube.
|
🌍 **Une plateforme multimédia indépendante au service de la vision panafricaniste et indépendantiste réunionnaise**
|
||||||
|
|
||||||
## Description
|
## 📖 Description
|
||||||
|
|
||||||
kaubuntu.re est une interface web responsive qui permet de consulter et rechercher des vidéos hébergées sur une instance PeerTube. La plateforme est conçue pour être légère, facilement déployable sur un serveur mutualisé, et optimisée pour les appareils mobiles et desktop.
|
kaubuntu.re est une interface web responsive qui permet de consulter et rechercher des vidéos hébergées sur une instance PeerTube. Il est également possible de suivre le fil du réseau social koze.kaubuntu.re (Mastodon). Développée par le mouvement politique **Ka-Ubuntu**, cette plateforme est conçue pour être légère, facilement déployable sur un serveur mutualisé, et optimisée pour les appareils mobiles et desktop.
|
||||||
|
|
||||||
## Fonctionnalités
|
🎯 **Mission** : Offrir une alternative libre et décentralisée aux plateformes vidéo traditionnelles, en phase avec les valeurs d'indépendance et de souveraineté numérique défendues par Ka-Ubuntu.
|
||||||
|
|
||||||
- Affichage des vidéos à la une et récentes
|
## ✨ Fonctionnalités
|
||||||
- Navigation par catégories
|
|
||||||
- Lecture de vidéos
|
|
||||||
- Recherche de contenu
|
|
||||||
- Interface responsive (mobile et desktop)
|
|
||||||
- Intégration avec une instance PeerTube
|
|
||||||
- **Progressive Web App (PWA)** avec installation native
|
|
||||||
- Mode hors ligne avec cache intelligent
|
|
||||||
- Détection automatique d'état de connexion
|
|
||||||
|
|
||||||
## Technologies utilisées
|
- 🎥 Affichage des vidéos à la une et récentes
|
||||||
|
- 📚 Navigation par catégories
|
||||||
|
- ▶️ Lecture de vidéos
|
||||||
|
- 🔍 Recherche de contenu
|
||||||
|
- 📱 Interface responsive (mobile et desktop)
|
||||||
|
- 🔗 Intégration avec une instance PeerTube
|
||||||
|
- 📲 Progressive Web App (PWA) avec installation native
|
||||||
|
- 🌐 Mode hors ligne avec cache intelligent
|
||||||
|
- 📡 Détection automatique d'état de connexion
|
||||||
|
|
||||||
- HTML5
|
## 🛠️ Technologies utilisées
|
||||||
- CSS3 avec Media Queries pour le responsive design
|
|
||||||
- PHP pour le backend
|
|
||||||
- JavaScript pour les interactions côté client
|
|
||||||
- **Service Worker** pour le cache offline et PWA
|
|
||||||
- **Web App Manifest** pour l'installation native
|
|
||||||
- Bibliothèques externes via CDN:
|
|
||||||
- Font Awesome (icônes)
|
|
||||||
- jQuery
|
|
||||||
|
|
||||||
## Structure du projet
|
- 📄 HTML5
|
||||||
|
- 🎨 CSS3 avec Media Queries pour le responsive design
|
||||||
|
- 🐘 PHP pour le backend
|
||||||
|
- ⚡ JavaScript pour les interactions côté client
|
||||||
|
- 🔧 Service Worker pour le cache offline et PWA
|
||||||
|
- 📋 Web App Manifest pour l'installation native
|
||||||
|
- 📦 Bibliothèques externes via CDN:
|
||||||
|
- 🎯 Font Awesome (icônes)
|
||||||
|
- 📚 jQuery
|
||||||
|
|
||||||
|
## 📁 Structure du projet
|
||||||
|
|
||||||
```
|
```
|
||||||
├── css/
|
├── css/
|
||||||
@@ -51,28 +53,32 @@ kaubuntu.re est une interface web responsive qui permet de consulter et recherch
|
|||||||
│ ├── featured-videos.php
|
│ ├── featured-videos.php
|
||||||
│ ├── recent-videos.php
|
│ ├── recent-videos.php
|
||||||
│ ├── categories.php
|
│ ├── categories.php
|
||||||
│ └── pwa-init.php
|
│ ├── pwa-init.php
|
||||||
|
│ └── config.local.php.sample # Exemple de configuration locale
|
||||||
├── index.php
|
├── index.php
|
||||||
├── video.php
|
├── video.php
|
||||||
├── categories.php
|
├── categories.php
|
||||||
├── search.php
|
├── search.php
|
||||||
├── sw.js # Service Worker pour PWA
|
├── sw.js # Service Worker pour PWA
|
||||||
├── site.webmanifest # Manifest PWA
|
├── site.webmanifest.sample # Exemple de manifest PWA
|
||||||
├── browserconfig.xml # Configuration Windows
|
├── browserconfig.xml # Configuration Windows
|
||||||
|
├── sitemap.xml.sample # Exemple de sitemap
|
||||||
|
├── robots.txt.sample # Exemple de robots.txt
|
||||||
|
├── mentions-legales.php.sample # Exemple de mentions légales
|
||||||
└── README.md
|
└── README.md
|
||||||
```
|
```
|
||||||
|
|
||||||
## Installation
|
## 🚀 Installation
|
||||||
|
|
||||||
1. Clonez ce dépôt
|
1. 📥 Clonez ce dépôt
|
||||||
2. Configurez votre serveur web (Apache, Nginx, etc.) pour pointer vers le répertoire racine
|
2. 🔧 Configurez votre serveur web (Apache, Nginx, etc.) pour pointer vers le répertoire racine
|
||||||
3. **Important :** Assurez-vous que votre serveur supporte HTTPS (requis pour PWA)
|
3. 🔒 **Important :** Assurez-vous que votre serveur supporte HTTPS (requis pour PWA)
|
||||||
|
|
||||||
## Configuration
|
## ⚙️ Configuration
|
||||||
|
|
||||||
Le site utilise un système de configuration en deux parties :
|
Le site utilise un système de configuration en deux parties :
|
||||||
- `includes/config.php` : La configuration de base (versionnée)
|
- 📋 `includes/config.php` : La configuration de base (versionnée)
|
||||||
- `includes/config.local.php` : Votre configuration locale (non versionnée)
|
- 🔧 `includes/config.local.php` : Votre configuration locale (non versionnée)
|
||||||
|
|
||||||
Pour configurer votre environnement local :
|
Pour configurer votre environnement local :
|
||||||
|
|
||||||
@@ -90,7 +96,7 @@ Pour configurer votre environnement local :
|
|||||||
|
|
||||||
Les modifications apportées à `config.local.php` ne seront pas suivies par Git, ce qui vous permet de personnaliser votre instance sans affecter le code source principal.
|
Les modifications apportées à `config.local.php` ne seront pas suivies par Git, ce qui vous permet de personnaliser votre instance sans affecter le code source principal.
|
||||||
|
|
||||||
## Personnalisation des catégories
|
## 🏷️ Personnalisation des catégories
|
||||||
|
|
||||||
Pour personnaliser les catégories affichées sur la page d'accueil, modifiez la constante `PRIORITY_CATEGORIES` dans votre fichier `config.local.php` :
|
Pour personnaliser les catégories affichées sur la page d'accueil, modifiez la constante `PRIORITY_CATEGORIES` dans votre fichier `config.local.php` :
|
||||||
|
|
||||||
@@ -108,14 +114,14 @@ define('PRIORITY_CATEGORIES', [
|
|||||||
- Les valeurs sont les noms personnalisés que vous souhaitez afficher
|
- Les valeurs sont les noms personnalisés que vous souhaitez afficher
|
||||||
- L'ordre dans le tableau détermine l'ordre d'affichage sur la page
|
- L'ordre dans le tableau détermine l'ordre d'affichage sur la page
|
||||||
|
|
||||||
## Personnalisation
|
## 🎨 Personnalisation
|
||||||
|
|
||||||
Vous pouvez personnaliser l'apparence de la plateforme en modifiant les fichiers CSS dans le dossier `css/`. Pour changer le logo et les couleurs principales:
|
Vous pouvez personnaliser l'apparence de la plateforme en modifiant les fichiers CSS dans le dossier `css/`. Pour changer le logo et les couleurs principales:
|
||||||
|
|
||||||
1. Remplacez le fichier `img/logo.png` par votre propre logo
|
1. 🖼️ Remplacez le fichier `img/logo.png` par votre propre logo
|
||||||
2. Modifiez les couleurs dans `css/styles.css`
|
2. 🎨 Modifiez les couleurs dans `css/styles.css`
|
||||||
|
|
||||||
## Personnalisation du sitemap, robots.txt, webmanifest et mentions légales
|
## 📝 Personnalisation du sitemap, robots.txt, webmanifest et mentions légales
|
||||||
|
|
||||||
Les fichiers `sitemap.xml`, `robots.txt`, `site.webmanifest` et `mentions-legales.php` contiennent des données spécifiques au domaine (`kaubuntu.re`). Pour les adapter à votre domaine :
|
Les fichiers `sitemap.xml`, `robots.txt`, `site.webmanifest` et `mentions-legales.php` contiennent des données spécifiques au domaine (`kaubuntu.re`). Pour les adapter à votre domaine :
|
||||||
|
|
||||||
@@ -133,64 +139,66 @@ Les fichiers `sitemap.xml`, `robots.txt`, `site.webmanifest` et `mentions-legale
|
|||||||
|
|
||||||
Ces fichiers sont listés dans le `.gitignore` afin que vos modifications ne soient pas suivies par Git, ce qui vous permet de personnaliser votre instance sans affecter le code source principal.
|
Ces fichiers sont listés dans le `.gitignore` afin que vos modifications ne soient pas suivies par Git, ce qui vous permet de personnaliser votre instance sans affecter le code source principal.
|
||||||
|
|
||||||
## Progressive Web App (PWA)
|
## 📱 Progressive Web App (PWA)
|
||||||
|
|
||||||
Cette plateforme est une PWA complète offrant :
|
Cette plateforme est une PWA complète offrant :
|
||||||
|
|
||||||
### Fonctionnalités PWA
|
### ✨ Fonctionnalités PWA
|
||||||
|
|
||||||
- **Installation native** : Bouton d'installation automatique dans l'interface
|
- 📲 **Installation native** : Bouton d'installation automatique dans l'interface
|
||||||
- **Mode hors ligne** : Cache intelligent des pages et ressources visitées
|
- 🌐 **Mode hors ligne** : Cache intelligent des pages et ressources visitées
|
||||||
- **Détection d'état** : Indicateur visuel en cas de perte de connexion
|
- 📡 **Détection d'état** : Indicateur visuel en cas de perte de connexion
|
||||||
- **Performance** : Chargement instantané des ressources en cache
|
- ⚡ **Performance** : Chargement instantané des ressources en cache
|
||||||
- **Responsive** : Interface adaptée pour l'utilisation en application mobile
|
- 📱 **Responsive** : Interface adaptée pour l'utilisation en application mobile
|
||||||
|
|
||||||
### Comment installer l'application
|
### 📥 Comment installer l'application
|
||||||
|
|
||||||
1. **Automatique** : Un bouton "Installer" apparaît dans le header lors de la première visite
|
1. 🔄 **Automatique** : Un bouton "Installer" apparaît dans le header lors de la première visite
|
||||||
2. **Manuel** :
|
2. 🔧 **Manuel** :
|
||||||
- **Chrome/Edge** : Menu → "Installer kaubuntu.re"
|
- 🌐 **Chrome/Edge** : Menu → "Installer kaubuntu.re"
|
||||||
- **Safari iOS** : Partager → "Ajouter à l'écran d'accueil"
|
- 🍎 **Safari iOS** : Partager → "Ajouter à l'écran d'accueil"
|
||||||
- **Firefox Android** : Menu → "Installer"
|
- 🦊 **Firefox Android** : Menu → "Installer"
|
||||||
|
|
||||||
### Compatibilité PWA
|
### 🌐 Compatibilité PWA
|
||||||
|
|
||||||
- ✅ Chrome/Edge (Android/Desktop)
|
- ✅ Chrome/Edge (Android/Desktop)
|
||||||
- ✅ Safari (iOS 11.3+)
|
- ✅ Safari (iOS 11.3+)
|
||||||
- ✅ Firefox (Android)
|
- ✅ Firefox (Android)
|
||||||
- ✅ Samsung Internet
|
- ✅ Samsung Internet
|
||||||
|
|
||||||
### Fichiers PWA
|
### 📄 Fichiers PWA
|
||||||
|
|
||||||
- `sw.js` : Service Worker gérant le cache et mode offline
|
- 🔧 `sw.js` : Service Worker gérant le cache et mode offline
|
||||||
- `site.webmanifest` : Configuration de l'application (nom, icônes, etc.)
|
- 📋 `site.webmanifest` : Configuration de l'application (nom, icônes, etc.)
|
||||||
- `browserconfig.xml` : Support des tuiles Windows
|
- 🪟 `browserconfig.xml` : Support des tuiles Windows
|
||||||
|
|
||||||
## Déploiement
|
## 🚀 Déploiement
|
||||||
|
|
||||||
Pour déployer sur un serveur mutualisé:
|
Pour déployer sur un serveur mutualisé:
|
||||||
|
|
||||||
1. Assurez-vous que votre hébergeur supporte PHP (version 7.0 minimum recommandée)
|
1. 🐘 Assurez-vous que votre hébergeur supporte PHP (version 7.0 minimum recommandée)
|
||||||
2. **Configurez HTTPS** (obligatoire pour les fonctionnalités PWA)
|
2. 🔒 **Configurez HTTPS** (obligatoire pour les fonctionnalités PWA)
|
||||||
3. Transférez tous les fichiers via FTP dans le répertoire racine de votre site
|
3. 📤 Transférez tous les fichiers via FTP dans le répertoire racine de votre site
|
||||||
4. Vérifiez que les permissions des fichiers sont correctement définies (644 pour les fichiers, 755 pour les dossiers)
|
4. 🔧 Vérifiez que les permissions des fichiers sont correctement définies (644 pour les fichiers, 755 pour les dossiers)
|
||||||
5. Configurez votre domaine pour pointer vers le dossier où vous avez installé l'application
|
5. 🌐 Configurez votre domaine pour pointer vers le dossier où vous avez installé l'application
|
||||||
6. Testez l'installation PWA via les outils de développement du navigateur
|
6. 🧪 Testez l'installation PWA via les outils de développement du navigateur
|
||||||
|
|
||||||
## Développement
|
## 👨💻 Développement
|
||||||
|
|
||||||
Si vous souhaitez contribuer au développement:
|
Si vous souhaitez contribuer au développement:
|
||||||
|
|
||||||
1. Créez une branche pour vos modifications: `git checkout -b ma-nouvelle-fonctionnalité`
|
1. 🌿 Créez une branche pour vos modifications: `git checkout -b ma-nouvelle-fonctionnalité`
|
||||||
2. Committez vos changements: `git commit -m 'Ajout d'une nouvelle fonctionnalité'`
|
2. 💾 Committez vos changements: `git commit -m 'Ajout d'une nouvelle fonctionnalité'`
|
||||||
3. Poussez vers la branche: `git push origin ma-nouvelle-fonctionnalité`
|
3. 📤 Poussez vers la branche: `git push origin ma-nouvelle-fonctionnalité`
|
||||||
4. Soumettez une pull request
|
4. 🔀 Soumettez une pull request
|
||||||
|
|
||||||
## License
|
## 📜 License
|
||||||
|
|
||||||
Copyright (C) 2025 Cédric Famibelle-Pronzola & Ka-Ubuntu
|
Copyright (C) 2025 Cédric Famibelle-Pronzola & **Ka-Ubuntu**
|
||||||
|
|
||||||
### FR
|
> **Ka-Ubuntu** est un parti politique panafricaniste et indépendantiste réunionnais, œuvrant pour la souveraineté numérique et technologique de La Réunion dans une perspective panafricaniste.
|
||||||
|
|
||||||
|
### 🇫🇷 FR
|
||||||
|
|
||||||
Ce programme est un logiciel libre : vous pouvez le redistribuer et/ou le modifier selon les termes de la licence publique générale GNU Affero publiée par la Free Software Foundation, soit la version 3 de la licence, soit (à votre choix) toute version ultérieure.
|
Ce programme est un logiciel libre : vous pouvez le redistribuer et/ou le modifier selon les termes de la licence publique générale GNU Affero publiée par la Free Software Foundation, soit la version 3 de la licence, soit (à votre choix) toute version ultérieure.
|
||||||
|
|
||||||
@@ -198,7 +206,7 @@ Ce programme est distribué dans l'espoir qu'il sera utile, mais SANS AUCUNE GAR
|
|||||||
|
|
||||||
Vous devriez avoir reçu une copie de la licence publique générale GNU Affero avec ce programme. Si ce n'est pas le cas, consultez https://www.gnu.org/licenses/.
|
Vous devriez avoir reçu une copie de la licence publique générale GNU Affero avec ce programme. Si ce n'est pas le cas, consultez https://www.gnu.org/licenses/.
|
||||||
|
|
||||||
### EN
|
### 🇺🇸 EN
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
|
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
|
||||||
|
|
||||||
@@ -206,6 +214,10 @@ This program is distributed in the hope that it will be useful, but WITHOUT ANY
|
|||||||
|
|
||||||
You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.
|
You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
|
||||||
## Contact
|
## 📞 Contact
|
||||||
|
|
||||||
Pour toute question ou suggestion, veuillez nous contacter à [contact@kaubuntu.re](mailto:contact@kaubuntu.re).
|
Pour toute question ou suggestion concernant cette plateforme, veuillez nous contacter à [multimedia@kaubuntu.re](mailto:multimedia@kaubuntu.re).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
🌍 **Ka-Ubuntu** - *Pour une Réunion libre et souveraine dans l'unité panafricaniste* ✊🏿
|
||||||
|
|||||||
Reference in New Issue
Block a user