From 47f35da250821555ddebe094294c9d40fe4ca122 Mon Sep 17 00:00:00 2001 From: Fabrice P Date: Fri, 7 Aug 2020 11:21:53 +0000 Subject: [PATCH] Add README.md --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1793b65 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Projet WikiLerni + +## Introduction + +Vous trouverez sur ce dépôt le code source du projet WikiLerni que vous pouvez visiter une instance sur cette page : https://www.wikilerni.com +Le backend est développé avec Node.js v12/Express. +Le frontend en "Vanilla.js" :-) + Babel.js pour gérer les anciens navigateurs. + +Le code est fourni tel quel, sachant qu'il reste encore beaucoup de choses à faire... +Je me concentre pour l'instant sur la création des quizs et les améliorations du front-end pour les utilisateurs finaux. + +Les quizs du site sont aussi libres (CC BY-SA 3.0) et utilisables de manière autonome en enregistrant le fichier html localement. Seul l'enregistrement des résultats nécessite l'appel au serveur node.js. + +## Installation + +Il n'y a pas de script d'installation pour l'instant. +Cela viendra, mais en attendant, si vous souhaitez tenter une installation sur votre machine (je ne promets rien !), voici la procédure à suivre : + +- modifier le fichier example.env et renommer le : .env +- modifier le fichier config/instance-example.js et renommer le : instance.js +- créer une base de données vierge à l'aide du fichier models/wikilerni-crea.sql (doit fonctionner avec MySQL et MariaDB). +- installer les dépendances avec "npm install" +- lancer le serveur node + un serveur front pointant le répertoire /front/public/ +- créer un premier compte utilisateur avec /front/public/inscription.html et changer son statut directement dans la base de données pour "admin" ou "manager" pour lui permettre de publier des quizs, gérer les comptes utilisateurs, etc. +- l'enregistrement du premier quiz créera la page d'accueil du site "/front/public/index.html" (entre autres). \ No newline at end of file