Scribouilli est un outil pour créer un petit site facilement.
Cette version tente d'aider à faire des petits sites pour les législatives 2024.
- Ouvrir un terminal
- Récupérer le repo
git clone git@github.com:lechappeebelle/scribouilli.gitdans le dossier qui va bien - Rentrer dans le dossier
scribouilli - Faire
npm install - Builder le projet avec
npm run dev - Lancer le projet avec
npm startdans un autre terminal - Ouvrir dans votre navigateur préféré
http://localhost:8080/
- Forker le repo sur votre compte
- Modifier les settings
- Donner les droits en écriture a github action
- Pour déployer la branche
online
- Ajouter votre origine github pages (ex:
yaf.github.io) dans Scribouilli/toctoctoc/allowlist.csv
Voilà à quoi ça peut ressembler : github.com/yaf/scribouilli
Une fois les développements réalisés, vous pouvez faire une PR dans Scribouilli, en précisant votre url de développement pour que l'on puisse tester la modification.
Des pre-commit hooks sont installés automatiquement avec husky. Si jamais il sont trop contraignants,
il est possible de les ignorer avec l'option --no-verify de git commit.
Vous pouvez également lancer les tests en local avec :
npm run test
Pour rendre accessible une nouvelle route :
- créer un lien symbolique qui pointe vers
index.html;ln -s index.html <ma-route.html>
- créer la route dans [assets/scripts/scripts.js]
sequenceDiagram;
participant A as Scribouilli
participant B as Service d'identification OAuth
participant C as toctoctoc
participant D as Mon Compte GitHub
A->>B: Demande l'authentification à
B->>C: Vérifie les clefs auprès de
C->>B: Montre les infos à
B->>A: Donne son feu vert à
A->>D: Peut utiliser
Service d'identification OAuth: le service OAuth actuellement implémenté est celui de GitHub. On va intégrer prochainement GitLab.toctoctoc: un serveur générique qui permet de se connecter à un service d'identification OAuth.
- Notre benchmark de départ