🌳Arborescence

Apprenez en plus sur la structure globale des fichiers du projet.

Structure

Le projet est organisé en plusieurs dossiers et sous-dossiers comme décrit ci dessous. Il est important de connaitre et respecter la structure afin de garder une consistance dans le projet.

.github

Fichiers en rapport avec GitHub tels que les modèles d'issues, de pull requests ou encore la politique de sécurité.

• ISSUE_TEMPLATE Dossier avec les fichiers des modèles d'issues.

• CONTRIBUTING.md Guide de contribution

• PULL_REQUEST_TEMPLATE.md Modèle pour les Pull Request

• SECURITY.md Politique de sécurité

• funding.yml Intégration dans GitHub du lien Ko-Fi

Data

Fichiers de configuration utilisés par les différents scripts.

• emoji_cours_names.json Fichier JSON avec les correspondances entre les noms de matières et les émojis associés.

• subject_names_format.json Fichier JSON avec les réécritures au propre des noms des matières ainsi que le déterminant à utiliser.

Fonts

Fichiers des polices d'écritures utilisées dans les différentes interfaces. Les polices utilisées sont Satoshi et Cabinet Grotesk

Server

Fichiers relatifs au Backend en charge de l'API.

• app.py Script principal de l'API

• /static Dossier accéssible au public

  • robots.txt

Web

Arborescence détaillée des fichiers et dossiers pour le site et l'application (pwa) :

/Website
      ├── /langs #Traductions
          ├── fr.json
          ├── es.json
          ├── en.json
      
      ├── /scripts #JavaScript
          ├── sw.js
          ├── support.js
          ├── status_checker.js
          ├── index.js
          ├── download.js
          ├── config.js 
      
      ├── /styles #CSS
          ├── support-style.css
          ├── index-style.css
          ├── download-style.css 
                             
      ├── index.html
      ├── download.html
      ├── support.html
      ├── manifest.json
  
/images #Images 
  ├── /Website
      ├── /Assets
          ├── iphone.png
          
       ├── /Icons
           ├── /Dark
               ├── *.png
               
           ├── /Light
               ├── *.png
  ├── /pwa
      ├── /assets
          ├── logo.jpg
          
      ├── /splashes #Ecrans de chargements
          ├── /ios
              ├── *.png
              
/pwa #Application
    ├── /fonts #Polices
         ├── FixelVariable.ttf
         ├── FixelVariableItalic.ttf
     
 ├── /scripts #JavaScript
     ├── jsQR.js
     ├── pwa.js
     
 ├── /styles #CSS
     ├── fonts.css
     ├── offline.css
     ├── pwa-style.css
     
 ├── index.htm
 ├── offline.htm
 ├── sw.js