Éconoris

Table des matières

Expand contents

• Éconoris
• Table des matières
• Présentation
• Fonctionnalités
• Architecture de l'application
• Architecture de la base de données
  • Modèle Conceptuel de Données (MCD)
  • Modèle Logique de Données (MLD)
• Routes available
• Technologies utilisées
• Installation
• Autheur
• Report de bug et suggestions
• License

Présentation

Éconoris est une API web de gestion de finances personnelles. Elle permet de suivre ses dépenses, ses revenus, ses investissements, ses horaires et bien d'autre chose.

Toute-fois, cette API n'est pas déstinée à remplacer un logiciel de comptabilité professionel ni même l'application de votre banque. Elle est plutôt déstinée à vous aider à mieux gérer vos finances personnelles, à suivre vos dépenses, vos revenus, vos abonnements, vos investissements et autres.

Fonctionnalités

• Gestion des dépenses
• Gestion des revenus
• Gestion des investissements
• Gestion des abonnements
• Gestion des horaires
• Gestion automatique des revenues en fonction des horaires et du taux horaire
• Gestion automatique des dépenses en fonction des abonnements
• Indice de satisfaction financière
• Conseils financiers
• Gestion des objectifs financiers
• Gestion des prêts

Architecture de l'application

flowchart RL

A[(Database)] <--> |SQL| B[Models]
B <==> C[Controllers]
C -.-> |HTTP Response: JSON| F{Client}
F --> |HTTP Request| C

Loading

Architecture de la base de données

Modèle Conceptuel de Données (MCD)

classDiagram
  direction TB

  class operations{
    **id** : Interger
    **operations_date** : Date
    **amount** : Numeric
    **source** : Varchar
    **destination** : Varchar
    **costs** : Numeric
    **category** : Varchar
    **validate** : Boolean
    **redundancy** : Varchar
  }

  class loans {
    **id** : Interger
    **loans_date** : Date
    **borrower** : Varchar
    **amount** : Numeric
    **refunded_amount** : Numeric
    **loan_reason** : Varchar
  }

  class timetable{
    **id** : Interger
    **timetable_date** : Date
    **hours_number** : Numeric
    **hourly_rate** : Numeric
  }

Loading

Modèle Logique de Données (MLD)

• operations(operations_id, operations_date, operations_amount, operations_source, operations_destination, operations_costs, operations_category, operations_validate, operations_redundancy, loans_createdat, operations_userid)
• loans(loans_id, loans_date, loans_borrower, loans_amount, loans_refundedamount, loans_loanreason, loans_createdat, loans_userid)
• timetable(timetable_id, timetable_date, timetable_hoursnumber, timetable_hourlyrate, timetable_createdat, timetable_userid)

Routes available

For full documentation please see https://domaine.name/api-docs or read '/docs/swagger.json' in Swagger editor

Action	Méthode	Route	Type de données retournée	Description
Select	GET	/operations	JSON	Get all operations
Select	POST	/operations/get	JSON	Get a part of the operations
Create	POST	/operations	JSON	Create one or multiple operations
Create	POST	/operation	JSON	Create only one operation
Update	PUT	/operations	JSON	Update one or multiple operations
Delete	DELETE	/operations	JSON	Delete one or multiple operations

Technologies utilisées

Éconoris est une application web développée avec les technologies suivantes :

• Langages :
  • JavaScript (TypeScript)
  • HTML
  • CSS
• Frameworks et librairies :
  • ExpressJS
  • dotenv
  • strftime
  • path
  • node postgres
• Base de données :
  • PostgreSQL
• Deployement :
  • Docker

Installation

comming soon...

Autheur

Éconoris est un projet open-source développé uniquement par Floris Robart

Report de bug et suggestions

Si vous découvrez une erreur, quelquelle soit, cela peut êgre une faute de frappe ou d'orthographe, une erreur de calcul, une erreur de conception, un bug qui empêche le bon fonctionnement de l'application, ou tout autre problème, Merci de me le signaler par mail à l'adresse [email protected]. Toutes les erreurs, quelque soit leur nature ou leur importance, seront traitées le plus rapidement possible.

Si vous avez une une suggestion, une idée, une amélioration, ou une demande de fonctionnalité, merci de me la communiquer par mail à l'adresse [email protected]. Toutes les suggestions, quelque soit leur nature ou leur importance, seront étudiées et prises en compte dans la mesure du possible.

License

Éconoris est un projet open-source sous licence GNU General Public License v3.0.