[DEPRECATED] Dev Documentation (Français) - dofapi/crawlit-dofus-encyclopedia-parser GitHub Wiki

Documentation(dev)

Installer le projet

Pour installer le projet sur votre machine, c'est simple : Clonez ce dépôt localement :

git clone https://github.com/kaido/deskofus.git

Installer les dependences avec npm :

npm install

Commandes incluse

Commandes Description
npm start Lance l'application dans votre interface en ligne de commande (NB: dans certains CLI inquirer ne fonctionne pas)
node lib/app.js Pareil que npm start mais fonctionne avec tous les CLI
npm run pkg-win Package votre app en exécutable windows (plus besoin de nodejs pour lancer l'app)
npm run pkg-linux Package votre app en exécutable linux (plus besoin de nodejs pour lancer l'app)
npm run pkg-mac Package votre app en exécutable macos (plus besoin de nodejs pour lancer l'app)
npm run pkg-all Package votre app pour Windows, Linux et MacOS en une commande

Comprendre le projet

Pour comprendre le projet et pour par la suite pouvoir y contribuer, il faut d'abord en saisir l'arborescence.

Crawlit
└───README.md    
└───assets (only few images for styling the repo)
└───package.json
└───LICENSE
|
└───lib
│   └───app.js
|   └───getItems.js
|   |
│   └───cli-view
│   │   │   cmd.js
│   │   │   cmdSwitch.js
│   │   │   ...
│   └───item-crawler
│       │   getEquipments.js
│       │   getMounts.js
│       │   ...
└───node_modules

app.js and getItems.js

A la racine du projet vous trouverez le fichier lib/app.js qui contient notre code principal (lancement du programme, chargement des propriétés et configuration globale de l'application). Vous y trouverez également le fichier getItems.js qui s'occupe de la logique de parsing des items.

Le dossier cli-view Gere les vues

Le dossier cli-view contient la partie renderer de notre application ainsi que toutes les interactions avec l'app. Vous y trouverez :

  • Le fichier cmd.js : gère les interactions entre le l'utilisateur et le programme.
  • Le fichier cmdSwitch.js : gère tous les liens vers les catégories (Dofus & Dofus-Touch).

Le dossier item-crawler Gere le parsing des items de chaque categorie

Le dossier contient un fichier par catégorie sachant que chaque fichier parse une catégorie de l'encyclopédie (requête + persistance de la donnée).

Développer un module

Pour développer un module, il y a certaines règles à respecter :

  • Ajoutez le lien de vos catégories au fichier cmdSwitch.js dans cmd-view/ (n'oubliez pas de modifier également cmdSwitchEn.js si vous voulez la version anglaise également).
  • Ajoutez le nom de vos catégories dans la fonction getData() du fichier getItems.js.
  • Updatez le fichier cmd.js et ajoutez votre catégorie au menu de sélection. Pensez si besoin à créer / modifier les questions pour plus d'interactions avec l'utilisateur (prenez exemple sur les catégories existante).
  • Créez un nouveau fichier sous item-crawler/.
  • Nommez le : getCategorie.js.
  • Créez votre logique de parsing dans ce fichier (prenez exemple sur les catégories existante).

Enjoy guys ! N'hésitez pas à me poser des questions ou à participer au discord ! :smiley: