Skip to content

qldwin/AirGap

Repository files navigation

AirGap - Vos finances ne regardent que vous.

Une application web open-source et complète pour gérer vos finances personnelles, développée avec Nuxt.js, Drizzle ORM, PostgreSQL.

🚀 Fonctionnalités

Gestion Financière Complète

  • Tableau de bord interactif avec visualisations en temps réel
  • Gestion budgétaire avec suivi des dépenses par catégorie
  • Suivi des transactions avec catégorisation automatique
  • Gestion des investissements (actions, ETF, crypto-monnaies) (à venir)
  • Calcul du patrimoine avec répartition des actifs et passifs (à venir)
  • Gestion multi-comptes bancaires (à venir)

Technologies Utilisées

  • Frontend: Nuxt.js 3, Vue 3, TailwindCSS
  • Backend: Drizzle ORM, PostgreSQL
  • Visualisations: Chart.js
  • Intégration bancaire: Firefly III API (à venir)
  • Conteneurisation: Docker & Docker Compose

Interface Moderne

  • Design épuré et professionnel
  • Tableau de bord interactif avec graphiques
  • Modales pour l'ajout rapide de données
  • Responsive design
  • Animations fluides

📦 Installation

Prérequis

  • Docker et Docker Compose
  • Node.js 18+ (pour le développement local)
  • PostgreSQL 15+

Installation Rapide avec Docker

  1. Cloner le repository
git clone https://github.com/qldwin/airgap.git
cd airgap
  1. Configurer les variables d'environnement
cp .env.example .env
# Éditer .env avec vos configurations
  1. Lancer l'application avec Docker Compose
docker-compose up -d
  1. Accéder à l'application

Installation pour le Développement

  1. Installer les dépendances
npm install
  1. Configurer la base de données

Nécessite la variable DATABASE_URL dans .env

npx drizzle-kit migrate
  1. Lancer le serveur de développement
npm run dev

🏗️ Architecture du Projet

airgap/
├── components/          # Composants Vue réutilisables
├── stores/             # Stores Pinia pour l'état global
├── server/             # API côté serveur
├── public/             # Fichiers statiques
├── docker-compose.yml  # Configuration Docker
├── package.json        # Dépendances du projet
└── README.md          # Documentation

🔧 Configuration

Variables d'Environnement

Créez un fichier .env à la racine du projet :

# Database
DATABASE_URL=postgresql://airgap_user:airgap_password@localhost:5432/airgap

📊 Base de Données

Schéma

La base de données inclut les tables suivantes :

  • users - Utilisateurs
  • accounts - Comptes bancaires
  • categories - Catégories de transactions
  • transactions - Transactions financières
  • budgets - Budgets mensuels
  • investments - Investissements et portefeuille
  • assets - Actifs du patrimoine
  • liabilities - Passifs et dettes

Migration

# Générer une nouvelle migration
npx drizzle-kit generate

# Exécuter les migrations
npx drizzle-kit migrate

# Ouvrir le studio Drizzle
npx drizzle-kit studio

🎯 Utilisation

Première Connexion

  1. Créer un compte utilisateur
  2. Configurer vos catégories de dépenses
  3. Définir vos budgets mensuels

Fonctionnalités Principales

Tableau de Bord

  • Vue d'ensemble des finances
  • Graphiques de tendances (Non implémenté)
  • Alertes et notifications (Non implémenté)

Gestion Budgétaire

  • Création de budgets par catégorie
  • Suivi en temps réel des dépenses (Non implémenté)
  • Alertes de dépassement (Non implémenté)

Investissements (Non implémenté)

  • Suivi du portefeuille
  • Performance des actifs
  • Répartition par type d'investissement

Patrimoine (Non implémenté)

  • Calcul de la valeur nette
  • Évolution du patrimoine
  • Répartition des actifs

🔒 Sécurité

  • Authentification utilisateur
  • Validation des entrées côté serveur
  • Protection CSRF
  • Sessions sécurisées

📱 Responsive Design

L'application est entièrement responsive et fonctionne sur :

  • Desktop (1920px+)
  • Tablette (768px - 1024px)
  • Mobile (320px - 768px)

📄 Licence

Ce projet est sous licence AGPLv3. Voir le fichier LICENSE pour plus de détails.

🆘 Support

Pour toute question ou problème :

  • Ouvrez une issue sur GitHub
  • Consultez la documentation
  • Contactez l'équipe de support

AirGap - Vos finances ne regardent que vous.

About

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •