But du projet

Ce projet est un exercice pratique de gestion des finances personnelles. Ce projet permet aux utilisateurs de mieux organiser leurs finances :

Fonctionalites du projet

Creation et gestion des comptes, categories et transactions. Importation des donnes depuis des fichiers csv Exportation des donnes en JSON Test unitaire avec Jest Documentation avec JSDoc Calculer le solde d'un compte avec une date donnee Calculer le flux monetaire d'une categorie entre deux dates (inclusivement)

Test unitaires

Pour executer les test unitaires, utilisez la commande: npm test

Les tests couvrent : la creation des comptes,categories, transactions. Importation de donnees depuis des fichiers CSV Exportation de donnees vers des fichiers JSON Calculer le solde d'un compte avec une date donnee Calculer le flux monetaire d'une categorie entre deux dates (inclusivement)

La documentation du projet est générée avec JSDoc.

Elle fournit une description détaillée des classes, méthodes, et fonctions utilisées dans le code. Executez npx jsdoc ./src --destination ./docs pour generer un HTML avec les commentaires

Initialisation et installation du projet et dependances

-npm init (initialiser projet) -npm install jest -npm install jsdoc -npm install csv-parse

Utilisation

NOTE: Pour tester la création de compte par exemple, il faut changer dans le fichier src/compte.js :

const fs = require('fs'); par import fs from 'fs'; → Parce que dans Node.js, avec "type": "module" dans le fichier package.json, on doit utiliser import au lieu de require. module.exports = Compte; par export default Compte; → Parce qu'avec les modules ES, on utilise export default pour exporter une classe ou une fonction, au lieu de module.exports qui est utilisé en CommonJS.

1. Creation de compte et exportation des donnes en JSON (L'exportation s'applique aussi pour categorie et transaction)

import Compte from './src/compte.js';

const compteCourant = new Compte('Compte Courant');
console.log(compteCourant);

// Exportation
const cheminFichier = './resultat/comptes.json';
Compte.exporterEnJSON([compteCourant], cheminFichier); 
console.log(`Comptes exportés dans le fichier : ${cheminFichier}`);

2. Creation de categorie

const Categorie = require('./src/categorie.js');
const categorieAlimentation = new Categorie('Alimentation', 'Dépenses alimentaires');
console.log(categorieAlimentation);

3. Creation de transactions:

const Transaction = require('./src/transaction.js');

// Création d'une transaction de revenu
const salaire = new Transaction(1000,'Compte Courant','2023-12-01','Salaire mensuel','revenu','Salaire');

// Affichage de la transaction créée
console.log(salaire);

4. Importation de donnes exemple:

const comptes = await creerComptesDepuisCSV('./data/comptes.csv');
const transactionsExportes = await creerTransactionsDepuisCSV('./data/transactions.csv');
const categories = await creerCategoriesDepuisCSV('./data/categories.csv');

5. Exportation de donnees en JSON exemple:

const transactions = await creerTransactionsDepuisCSV('./data/transactions.csv');
    const cheminFichier = './resultat/transactions.json';

    Transaction.exporterEnJSON(transactions, cheminFichier);


const comptes = await creerComptesDepuisCSV('./data/comptes.csv');
    const cheminFichier = './resultat/comptes.json';
    Compte.exporterEnJSON(comptes, cheminFichier); 


const categories = await creerCategoriesDepuisCSV('./data/categories.csv');
    const cheminFichier = './resultat/categories.json';
    
    Categorie.exporterEnJSON(categories, cheminFichier);