Ajouter README.md
This commit is contained in:
commit
73981fc8c8
115
README.md
Normal file
115
README.md
Normal file
@ -0,0 +1,115 @@
|
||||
# Plateforme de Publication de Romans en Ligne
|
||||
|
||||
Une plateforme web simple et élégante pour la publication et la lecture de romans en ligne, développée en PHP avec stockage JSON.
|
||||
|
||||
## 🚀 Fonctionnalités
|
||||
|
||||
### Zone Administrative
|
||||
- Interface sécurisée pour la gestion des contenus
|
||||
- Création et édition de romans avec éditeur WYSIWYG
|
||||
- Gestion flexible des chapitres
|
||||
- Prévisualisation avant publication
|
||||
- Stockage JSON pour une maintenance simplifiée
|
||||
|
||||
### Zone Publique
|
||||
- Interface de lecture épurée et confortable
|
||||
- Navigation intuitive entre les chapitres
|
||||
- Design responsive optimisé pour la lecture
|
||||
- Thème personnalisé aux tons bruns/ocre
|
||||
|
||||
## 📋 Prérequis
|
||||
|
||||
- PHP 8.0 ou supérieur
|
||||
- Serveur web (Apache/Nginx) avec mod_rewrite activé
|
||||
- Permissions d'écriture sur les dossiers `stories/` et `admin/`
|
||||
|
||||
## 🛠️ Installation
|
||||
|
||||
1. Clonez le dépôt :
|
||||
```bash
|
||||
git clone https://github.com/votre-username/nom-du-projet.git
|
||||
cd nom-du-projet
|
||||
```
|
||||
|
||||
2. Configurez votre serveur web pour pointer vers le dossier racine du projet
|
||||
|
||||
3. Copiez et modifiez le fichier de configuration :
|
||||
```bash
|
||||
cp config.example.json config.json
|
||||
```
|
||||
|
||||
4. Modifiez `config.json` avec vos paramètres :
|
||||
```json
|
||||
{
|
||||
"site": {
|
||||
"name": "Votre Site",
|
||||
"url": "https://votre-domaine.com",
|
||||
"description": "Description de votre site",
|
||||
"logo": "assets/images/logo.png"
|
||||
},
|
||||
"users": [
|
||||
{
|
||||
"id": "admin",
|
||||
"password": "votre_mot_de_passe_hashé"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
5. Définissez les permissions appropriées :
|
||||
```bash
|
||||
chmod 755 .
|
||||
chmod 644 config.json
|
||||
chmod -R 755 stories/
|
||||
```
|
||||
|
||||
## 📁 Structure du Projet
|
||||
|
||||
```
|
||||
/
|
||||
├── admin/ # Zone administrative sécurisée
|
||||
├── assets/ # Ressources statiques
|
||||
│ ├── css/
|
||||
│ ├── js/
|
||||
│ └── images/
|
||||
├── includes/ # Fichiers PHP réutilisables
|
||||
├── stories/ # Dossier contenant les récits (JSON)
|
||||
├── config.json # Configuration du site
|
||||
└── index.php # Page d'accueil publique
|
||||
```
|
||||
|
||||
## 🔒 Sécurité
|
||||
|
||||
- L'accès à la zone administrative est protégé par authentification
|
||||
- Les mots de passe sont hashés
|
||||
- Protection contre les attaques XSS et CSRF
|
||||
- Validation des données entrantes
|
||||
- Restrictions sur les types de fichiers uploadés
|
||||
|
||||
## 🌐 Utilisation
|
||||
|
||||
### Interface Administrative
|
||||
1. Accédez à `/admin` et connectez-vous
|
||||
2. Utilisez le menu pour gérer vos romans et chapitres
|
||||
3. L'éditeur WYSIWYG permet une mise en forme riche du texte
|
||||
4. Prévisualisez vos modifications avant publication
|
||||
|
||||
### Interface Publique
|
||||
- La page d'accueil liste tous les romans disponibles
|
||||
- Chaque roman a sa page dédiée avec description et chapitres
|
||||
- Navigation fluide entre les chapitres
|
||||
- Interface adaptative pour une lecture confortable sur tous les appareils
|
||||
|
||||
## 🤝 Contribution
|
||||
|
||||
Les contributions sont les bienvenues ! Pour contribuer :
|
||||
|
||||
1. Forkez le projet
|
||||
2. Créez une branche pour votre fonctionnalité
|
||||
3. Committez vos changements
|
||||
4. Poussez vers la branche
|
||||
5. Ouvrez une Pull Request
|
||||
|
||||
## 📝 License
|
||||
|
||||
Ce projet est sous licence MIT - voir le fichier [LICENSE.md](LICENSE.md) pour plus de détails.
|
Loading…
x
Reference in New Issue
Block a user