Giter VIP home page Giter VIP logo

asili's Introduction

Guide d'installation du projet

Ce guide vous accompagnera dans le processus d'installation et de lancement du projet en utilisant Docker Compose.

Prérequis

  • Docker
  • Docker Compose
  • Git (pour cloner le dépôt)

Structure du projet

Le projet a la structure suivante :

racine/
├── backend/         # Express avec TSOA
├── frontend/        # Frontend Vue.js
├── fakeApiLaPoste/  # API La Poste pour la gestion des livraisons
├── docker-compose.yml
├── .env
├── rgpd/            # Documents relatifs au RGPD
└── README.md

Étapes d'installation

  1. Clonez le dépôt :

    git clone https://github.com/annaelmoussa/Asili
    cd Asili
    
  2. Configurez les variables d'environnement :

    Créez trois fichiers .env : un dans le répertoire racine, un dans le répertoire backend, et un dans le répertoire frontend. Ajoutez les variables suivantes dans chaque fichier selon les besoins :

    .env à la racine :

    VITE_API_BASE_URL=http://localhost:3000
    VITE_STRIPE_PUBLIC_KEY=pk_test_556PJ
    POSTGRES_DB=postgres
    POSTGRES_USER=postgres
    POSTGRES_PASSWORD=password
    MONGO_INITDB_DATABASE=asili
    JWT_SECRET=secret
    [email protected]
    TRAEFIK_AUTH=test:$$apr1$$Q7Q7Q7Q7$$
    PORT=3000
    MONGO_URI=mongodb://mongo:27017/asili
    POSTGRES_URI=postgres://postgres:password@postgres:5432/postgres
    JWT_SECRET=secret
    [email protected]
    EMAIL_PASSWORD=password
    BASE_URL=http://localhost:8080
    REDIS_URL=redis://redis:6379
    STRIPE_SECRET_KEY=sk_test_91P
    

    .env dans le backend :

    VITE_API_BASE_URL=http://localhost:3000
    VITE_STRIPE_PUBLIC_KEY=pk_test_556PJ
    POSTGRES_DB=postgres
    POSTGRES_USER=postgres
    POSTGRES_PASSWORD=password
    MONGO_INITDB_DATABASE=asili
    JWT_SECRET=secret
    [email protected]
    TRAEFIK_AUTH=test:$$apr1$$Q7Q7Q7Q7$$
    PORT=3000
    MONGO_URI=mongodb://mongo:27017/asili
    POSTGRES_URI=postgres://postgres:password@postgres:5432/postgres
    JWT_SECRET=secret
    [email protected]
    EMAIL_PASSWORD=password
    BASE_URL=http://localhost:8080
    REDIS_URL=redis://redis:6379
    STRIPE_SECRET_KEY=sk_test_91P
    

    .env dans le frontend :

    VITE_API_BASE_URL=http://localhost:3000
    VITE_STRIPE_PUBLIC_KEY=pk_test_556PJ
    POSTGRES_DB=postgres
    POSTGRES_USER=postgres
    POSTGRES_PASSWORD=password
    MONGO_INITDB_DATABASE=asili
    JWT_SECRET=secret
    [email protected]
    TRAEFIK_AUTH=test:$$apr1$$Q7Q7Q7Q7$$
    PORT=3000
    MONGO_URI=mongodb://mongo:27017/asili
    POSTGRES_URI=postgres://postgres:password@postgres:5432/postgres
    JWT_SECRET=secret
    [email protected]
    EMAIL_PASSWORD=password
    BASE_URL=http://localhost:8080
    REDIS_URL=redis://redis:6379
    STRIPE_SECRET_KEY=sk_test_91P
    
  3. Construisez et démarrez les conteneurs Docker :

    docker-compose up --build
    

    Cette commande va construire les images pour vos services et démarrer les conteneurs.

  4. Une fois les conteneurs démarrés, vous pouvez accéder à :

Informations supplémentaires

  • Le backend utilise Express avec TSOA et se trouve dans le répertoire backend.
  • Le frontend est construit avec Vue.js et se trouve dans le répertoire frontend.
  • Les données MongoDB sont persistées dans le volume mongo_data.
  • Les données PostgreSQL sont persistées dans le volume postgres_data.
  • Assurez-vous de remplacer toutes les valeurs d'exemple dans les fichiers .env par votre configuration réelle.

Informations supplémentaires

  • Le backend utilise Express avec TSOA et se trouve dans le répertoire backend.
  • Le frontend est construit avec Vue.js et se trouve dans le répertoire frontend.
  • Les données MongoDB sont persistées dans le volume mongo_data.
  • Les données PostgreSQL sont persistées dans le volume postgres_data.
  • Assurez-vous de remplacer toutes les valeurs d'exemple dans les fichiers .env par votre configuration réelle.
  • Le dossier rgpd contient tous les documents relatifs au RGPD.

Environnement de production

L'application en production est accessible à l'adresse : https://littleyarns.org/

Comptes de test

Pour tester l'application, vous pouvez utiliser les comptes suivants :

  1. Rôle User :

  2. Rôle Admin :

  3. Rôle Store Keeper :

Contributeurs et fonctionnalités

Annaël Moussa (GitHub: annaelmoussa)

  • Recherche produits
  • Gestion des stocks
  • Panel d'administration
  • "Suppression" de compte
  • Système de réservation de 15min pour les paniers
  • Composant CRUD
  • Fake API Laposte

Lotfi Touil (GitHub: Lotfi-Touil)

  • Système de paiement via Stripe (paiement + webhooks)
  • Gestion de livraison
  • Système de commande avec historique
  • Panier Hors-ligne + Panier en ligne
  • Dénormalisation PostgreSQL/MongoDB

Jason Alfonso (GitHub: JasonAfs)

  • Gestion d'alerte par mail (Visibilité de l'ensemble des alertes sur le compte client)
  • Authentification

Raouf Abdou Msa (GitHub: raouf-abdoumsa)

  • Design Frontend
  • Tests unitaires
  • Droits / RGPD
  • Gestion d'erreur

Dépannage

Si vous rencontrez des problèmes lors de l'installation ou de l'exécution du projet, veuillez suivre ces étapes :

  1. Assurez-vous que tous les ports requis sont libres et non utilisés par d'autres applications.

  2. Vérifiez que toutes les variables d'environnement sont correctement définies dans les fichiers .env respectifs.

  3. En cas de problème avec le lancement du projet, suivez ces étapes dans l'ordre :

    a. Dans le répertoire backend :

    cd backend
    npm run build
    

    b. Dans le répertoire frontend :

    cd frontend
    npm run build
    npm run generate-api
    

    c. Retournez à la racine du projet et exécutez :

    docker compose down -v && docker compose up --build -d
    

    Cette séquence de commandes va reconstruire les projets backend et frontend, générer l'API dans le frontend, puis recréer et redémarrer tous les conteneurs Docker.

  4. Si les problèmes persistent, consultez les logs Docker pour tout message d'erreur :

    docker-compose logs
    

Pour toute assistance supplémentaire, veuillez contacter le responsable du projet.

asili's People

Contributors

annaelmoussa avatar lotfi-touil avatar jasonafs avatar raouf-abdoumsa avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.