README.md

Zeste de Savoir

Site internet communautaire propulsé par le framework Django 1.10 et Python 3.

Jetez donc un coup d’œil à notre feuille de route.

Comment démarrer une instance de ZdS ?

Installation d’une version locale de ZdS

• Installation du backend sur Windows
• Installation du backend sur Linux
• Installation du backend sur OS X
• Installation du frontend
• Installation de Elasticsearch pour gérer la recherche

Mettre à jour votre version locale de ZdS

Après avoir mis à jour votre dépôt, vous devez exécuter les commandes suivantes (depuis la racine de votre projet) pour mettre à jour les dépendances.

pip install --upgrade -r requirements-dev.txt
./manage.py migrate --fake-initial

Données de test

Pour bénéficier de données de test, exécutez les commandes suivantes, dans l’ordre, à la fin des précédentes :

./manage.py loaddata fixtures/*.yaml
./manage.py load_factory_data fixtures/advanced/aide_tuto_media.yaml

Si vous êtes sur Windows, la première commande ne fonctionnera pas, préférez ceci :

python .\manage.py loaddata (dir .\fixtures\*.yaml)
python .\manage.py load_factory_data .\fixtures\advanced\aide_tuto_media.yaml

Cela va créer plusieurs entitées :

• 8 utilisateurs (utilisateur/mot de passe) :
  • user/user : Utilisateur normal ;
  • staff/staff : Utilisateur avec les droits d’un staff ;
  • admin/admin : Utilisateur avec les droits d’un staff et d’un admin ;
  • anonymous/anonymous : Utilisateur qui permet l’anonymisation des messages sur les forums ;
  • Auteur externe/external : Utilisateur qui permet de récupérer les tutoriels d’anciens membres et/ou de publier des tutoriels externes ;
  • ïtrema/ïtrema : Utilisateur de test supplémentaire sans droits ;
  • decal/decal : le compte qui possède un identifiant Profile différent de l’identifiant user pour permettre de tester des cas ou ces id sont différents ;
  • dev/dev : Utilisateur dans le groupe des développeurs ;
• 3 catégories ;
• 11 forums ;
• 3 sujets avec une réponse ;
• 1 message privé (MP) avec 3 participants ;
• 3 catégories et 2 sous-catégories ;
• 4 aides pour l’écriture des tutoriels ;
• 5 unes mises en avant sur la page d’accueil.

Pour en savoir plus sur cette commande, consulter la documentation.

La documentation complète

Voir la documentation en ligne.

La documentation de ZdS est générée par Sphinx, et elle doit être mise à jour à chaque modification ou ajout d’une fonctionnalité du site. Les sources se trouvent ici.

Pour générer la documentation en local, rendez-vous dans le répertoire zds-site/doc/ depuis votre terminal, et lancez la commande make html. Vous pourrez ensuite la consulter en ouvrant le fichier zds-site/doc/build/html/index.html.

Conseils de développement

Vous trouverez tout sur la page dédiée de la documentation.

Code de Conduite Contributeurs

En contribuant, vous vous engagez à respecter le Code de Conduite Contributeurs.

En savoir plus

• Comment déployer ZDS sur un serveur de production ?
• Comment contribuer et conseils de développement
• Comment contribuer : comprendre comment suivre le workflow (sur zds)
• Les détails du workflow utilisé sur Zeste de Savoir

Zeste de Savoir est basé sur un fork de Progdupeupl (voir le dépôt Git).