docs: ajout documentation technique complete et configuration .gitignore
Cette révision appartient à :
1 Parent
65170df73b
révision
3e99152738
3 fichiers modifiés
+201
-1
Aucun fichier ne correspond à votre recherche
@@ -0,0 +1,145 @@
|
||||
# 📚 DOCUMENTATION TECHNIQUE & GUIDE PROJET - JOBRUNNER
|
||||
|
||||
> **Plateforme de mise en relation de services et prestations avec séquestre bancaire sécurisé.**
|
||||
> **Dépôt privé :** `https://github.com/gastinelt/jobrunner.html`
|
||||
> **Nom de domaine de production :** `https://jobrunner.fr`
|
||||
|
||||
---
|
||||
|
||||
## 📑 Sommaire
|
||||
1. [Vue d'ensemble du Projet](#1-vue-densemble-du-projet)
|
||||
2. [Architecture et Organisation des Fichiers](#2-architecture-et-organisation-des-fichiers)
|
||||
3. [Règles de Travail sur le Dépôt Git Privé](#3-règles-de-travail-sur-le-dépôt-git-privé)
|
||||
4. [Fonctionnalités Actuelles du Site (Frontend)](#4-fonctionnalités-actuelles-du-site-frontend)
|
||||
5. [Spécifications Techniques des APIs à Intégrer](#5-spécifications-techniques-des-apis-à-intégrer)
|
||||
- [Paiements & Séquestre (Stripe)](#51-paiements--séquestre-stripe)
|
||||
- [Vérification d'Identité 100% Légale & Gratuite](#52-vérification-didentité-100-légale--gratuite)
|
||||
6. [Mise en Ligne & Configuration du Domaine `Jobrunner.fr`](#6-mise-en-ligne--configuration-du-domaine-jobrunnerfr)
|
||||
7. [Stratégie Marketing & Acquisition Réseaux Sociaux](#7-stratégie-marketing--acquisition-réseaux-sociaux)
|
||||
|
||||
---
|
||||
|
||||
## 1. Vue d'ensemble du Projet
|
||||
|
||||
**Jobrunner** met en relation des clients ayant un besoin de service du quotidien (bricolage, déménagement, ménage, urgences, livraisons, etc.) avec des prestataires indépendants et fiables appelés les **"Runners"**.
|
||||
|
||||
### Le modèle économique :
|
||||
* **Garantie Séquestre (Escrow) :** Les fonds du client sont débités et mis en sécurité lors de la réservation. Le runner n'est payé qu'une fois la prestation réalisée et validée par le client.
|
||||
* **Modèle 0 € de frais fixes :** Aucun abonnement récurrent pour le gérant. Les frais Stripe (~1,5% + 0,25 €) sont directement couverts par la commission de la plateforme (10% à 15%).
|
||||
* **Confiance & Conformité :** Respect strict des lois françaises (RGPD, CNIL, DSP2) et vérifications des profils (numéro de téléphone certifié, SIRET officiel État français, et pièce d'identité sécurisée).
|
||||
|
||||
---
|
||||
|
||||
## 2. Architecture et Organisation des Fichiers
|
||||
|
||||
```
|
||||
jobrunner web/
|
||||
├── .gitignore # Protection des clés privées, logs et dépendances
|
||||
├── README.md # Présentation du dépôt
|
||||
├── DOCUMENTATION.md # Présente documentation technique complète
|
||||
└── index.html # Application Web frontend complète (6600+ lignes)
|
||||
```
|
||||
|
||||
### Technologies du Frontend :
|
||||
* **HTML5 / JavaScript Vanilla :** Application Single Page dynamique sans framework lourd pour un chargement instantané.
|
||||
* **Tailwind CSS (CDN) :** Palette de couleurs sur-mesure (`#F4F2EC` écru/beige, `#7A8E76` sauge, `#1F221E` sombre).
|
||||
* **Phosphor Icons :** Bibliothèque d'icônes vectorielles moderne.
|
||||
* **Typographies :** Polices *Chillax* (titres modernes) et *Plus Jakarta Sans* (corps de texte).
|
||||
* **Responsive Hybride :** Conçu en priorité pour mobile (format app native avec dock de navigation bas) et adapté pour grand écran desktop.
|
||||
|
||||
---
|
||||
|
||||
## 3. Règles de Travail sur le Dépôt Git Privé
|
||||
|
||||
Pour garantir la sécurité et la propreté du travail d'équipe avec vos collaborateurs (`gastinelt` & `ronnetnils-cyber`) :
|
||||
|
||||
1. **Dépôt Privé Obligatoire :** Tout le code source, la documentation et les développements sont stockés sur le dépôt privé `gastinelt/jobrunner.html`.
|
||||
2. **Gestion des Secrets & Clés API :**
|
||||
* **JAMAIS** de clé secrète Stripe (`sk_live_...` ou `sk_test_...`) dans le code HTML/JS côté client.
|
||||
* Toutes les clés sensibles doivent résider dans un fichier `.env` ou sur le serveur backend uniquement.
|
||||
* Le fichier `.gitignore` bloque l'envoi de ces fichiers sensibles sur Git.
|
||||
3. **Commandes usuelles de synchronisation :**
|
||||
```bash
|
||||
# Récupérer les dernières modifications de vos collaborateurs
|
||||
git pull origin main
|
||||
|
||||
# Enregistrer vos modifications locales
|
||||
git add .
|
||||
git commit -m "description claire de vos modifications"
|
||||
|
||||
# Envoyer sur le dépôt privé GitHub
|
||||
git push origin main
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. Fonctionnalités Actuelles du Site (Frontend)
|
||||
|
||||
Le fichier `index.html` intègre déjà les modules complets suivants :
|
||||
|
||||
| Module | Description |
|
||||
| :--- | :--- |
|
||||
| **Accueil & Recommandations** | Bannière, recherche rapide, catégories de services, sélection de runners recommandés. |
|
||||
| **Moteur de Recherche & Filtres** | Filtres par catégorie, tarif horaire, localisation, badge vérifié, tri par avis. |
|
||||
| **Shorts / Vidéos UGC** | Lecteur vidéo vertical style TikTok/Reels intégré, présentant les prestations des runners. |
|
||||
| **Fiche Runner / Annonce** | Détails du profil, photos, tarifs, avis clients, garanties et bouton de réservation. |
|
||||
| **Messagerie Instantanée** | Système de messagerie interactif complet (vue liste + fenêtre de conversation dédiée). |
|
||||
| **Processus de Séquestre Mock** | Modale de paiement avec explication des fonds protégés et validation de fin de mission. |
|
||||
| **Espace Profil & Annonces** | Gestion des annonces personnelles, favoris, historique et statut de certification. |
|
||||
| **Footer & Mentions Légales** | Modales légales (Mentions légales, CGU, Politique de confidentialité RGPD, Cookies). |
|
||||
|
||||
---
|
||||
|
||||
## 5. Spécifications Techniques des APIs à Intégrer
|
||||
|
||||
### 5.1 Paiements & Séquestre (Stripe)
|
||||
|
||||
* **Objectif :** Bloquer les fonds du client jusqu'à validation du service.
|
||||
* **Fonctionnement :**
|
||||
1. Le client clique sur *"Réserver avec Séquestre"*.
|
||||
2. Le serveur appelle `stripe.paymentIntents.create` avec l'option `capture_method: 'manual'` (autorisation préalable).
|
||||
3. L'argent est bloqué sans être transféré au runner immédiatement.
|
||||
4. Fin de mission : le client valide $\rightarrow$ le serveur exécute `stripe.paymentIntents.capture` $\rightarrow$ les fonds sont libérés.
|
||||
* **Frais :** ~1,5% + 0,25 € par transaction par carte bancaire (couverts par les frais de service de la plateforme).
|
||||
|
||||
### 5.2 Vérification d'Identité 100% Légale & Gratuite
|
||||
|
||||
1. **Vérification SIRET Auto-entrepreneurs / Artisans (0 €) :**
|
||||
* **API Officielle :** `api.gouv.fr` (Base SIRENE État français).
|
||||
* **Vérification instantanée :** Le runner renseigne son SIRET $\rightarrow$ l'API confirme l'existence de l'entreprise, son immatriculation et son gérant légal $\rightarrow$ Attribution automatique du badge *"Pro Vérifié SIRET"*.
|
||||
2. **Vérification Numéro de Téléphone (0 €) :**
|
||||
* **API :** Google Firebase Phone Auth.
|
||||
* **Vérification :** Envoi d'un code SMS à 6 chiffres. En France, toute ligne mobile 06/07 est obligatoirement liée à une identité chez un opérateur téléphonique.
|
||||
3. **Vérification Pièce d'Identité CNI (Optionnelle via Stripe Identity) :**
|
||||
* Facturée ~1,50 € par vérification $\rightarrow$ Frais répercutés au runner qui choisit de débloquer le badge *"Identité Certifiée CNI"*.
|
||||
|
||||
---
|
||||
|
||||
## 6. Mise en Ligne & Configuration du Domaine `Jobrunner.fr`
|
||||
|
||||
### Pointage DNS du domaine :
|
||||
Dans l'interface de gestion de votre nom de domaine `Jobrunner.fr` (chez votre registrar) :
|
||||
|
||||
* **Enregistrement `A` :**
|
||||
* Hôte : `@`
|
||||
* Valeur : `IP_DE_VOTRE_SERVEUR`
|
||||
* **Enregistrement `CNAME` :**
|
||||
* Hôte : `www`
|
||||
* Valeur : `jobrunner.fr.`
|
||||
* **Certificat SSL / HTTPS :**
|
||||
* Activation du certificat HTTPS Let's Encrypt (gratuit) sur votre serveur pour un affichage sécurisé avec le cadenas vert.
|
||||
|
||||
---
|
||||
|
||||
## 7. Stratégie Marketing & Acquisition Réseaux Sociaux
|
||||
|
||||
### Deux cibles distinctes :
|
||||
1. **Les Clients (Demandeurs de services) :**
|
||||
* *Accroche :* "Besoin d'un coup de main en urgence ? Ne prenez aucun risque : vos fonds sont protégés par séquestre et le runner n'est payé que si vous êtes 100% satisfait."
|
||||
2. **Les Runners (Prestataires / Indépendants) :**
|
||||
* *Accroche :* "Comment gagner de 100 € à 300 € par semaine à côté de vos études ou de votre travail, avec la certitude d'être payé sans impayé."
|
||||
|
||||
### Formats Vidéos Recommandés :
|
||||
* **Shorts / TikTok / Reels (Format 9:16) :**
|
||||
* Utiliser le style UGC (face caméra, smartphone en main, authentique, sous-titres dynamiques).
|
||||
* Montrer la plateforme en action directement à l'écran grâce à l'interface mobile de Jobrunner.
|
||||
Référencer dans un nouveau ticket
Bloquer un utilisateur