Guide d'Installation
Ce guide vous aidera à installer et configurer rapidement notre plateforme.
Exigences Système
Exigences Minimales
- Node.js: 18.0.0 ou supérieur
- npm: 8.0.0 ou supérieur
- pnpm: 8.0.0 ou supérieur (recommandé)
- Mémoire: 4GB RAM
- Stockage: 2GB d'espace disponible
Configuration Recommandée
- Node.js: 20.0.0 ou supérieur
- Mémoire: 8GB RAM
- Stockage: 5GB d'espace disponible
- Système d'Exploitation: macOS 12+, Ubuntu 20.04+, Windows 10+
Étapes d'Installation
1. Cloner le Projet
git clone https://github.com/your-org/woker-job.git
cd woker-job
2. Installer les Dépendances
Utiliser pnpm (recommandé):
pnpm install
Ou utiliser npm:
npm install
3. Configuration de l'Environnement
Copier le fichier des variables d'environnement:
cp .env.example .env
Éditer le fichier .env
pour configurer les variables d'environnement nécessaires:
# Configuration de la base de données
DATABASE_URL="postgresql://username:password@localhost:5432/woker_job"
# Clé secrète JWT
JWT_SECRET="your-jwt-secret-key"
# Configuration frontend
NUXT_PUBLIC_FRONTEND_BASE_URL="http://localhost:3000"
NUXT_PUBLIC_BACKEND_BASE_URL="http://localhost:3001"
4. Configuration de la Base de Données
Utiliser Docker (Recommandé)
# Démarrer la base de données PostgreSQL
docker run --name woker-job-db \
-e POSTGRES_DB=woker_job \
-e POSTGRES_USER=postgres \
-e POSTGRES_PASSWORD=password \
-p 5432:5432 \
-d postgres:15
Installation Manuelle de PostgreSQL
- Télécharger et installer PostgreSQL
- Créer la base de données:
CREATE DATABASE woker_job;
CREATE USER woker_user WITH PASSWORD 'your_password';
GRANT ALL PRIVILEGES ON DATABASE woker_job TO woker_user;
5. Exécuter les Migrations de Base de Données
# Naviguer vers le répertoire backend
cd apps/back-end
# Exécuter les migrations
pnpm run migration:run
6. Démarrer le Serveur de Développement
Démarrer Tous les Services (Recommandé)
Dans la racine du projet:
pnpm run dev
Démarrer les Services Séparément
Service Backend:
cd apps/back-end
pnpm run start:dev
Service Frontend:
cd apps/web
pnpm run dev
7. Vérifier l'Installation
- Accéder à l'application frontend: http://localhost:3000
- Accéder à l'API backend: http://localhost:3001
- Vérifier la documentation API: http://localhost:3001/api
Déploiement en Production
Déploiement Docker
- Construire l'image:
docker build -t woker-job .
- Exécuter le conteneur:
docker run -d \
--name woker-job \
-p 3000:3000 \
-p 3001:3001 \
-e DATABASE_URL="your-production-db-url" \
woker-job
Déploiement Manuel
- Construire la version de production:
pnpm run build
- Démarrer les services de production:
pnpm run start
Problèmes Courants
Conflits de Ports
Si les ports 3000 ou 3001 sont occupés, vous pouvez modifier les variables d'environnement:
# Port frontend
PORT=3002
# Port backend
BACKEND_PORT=3003
Échec de Connexion à la Base de Données
- Vérifier si le service de base de données est en cours d'exécution
- Vérifier le format de la chaîne de connexion
- Confirmer les paramètres du pare-feu
Échec d'Installation des Dépendances
- Nettoyer le cache:
pnpm store prune
npm cache clean --force
- Supprimer node_modules et réinstaller:
rm -rf node_modules
pnpm install
Prochaines Étapes
Après l'installation, vous pouvez:
- Démarrage Rapide - Apprendre l'utilisation de base
- Concepts - Apprendre les concepts de base
- Documentation API - Voir la référence API
- Guide de Configuration - Apprendre la configuration avancée
Obtenir de l'Aide
Si vous rencontrez des problèmes lors de l'installation:
- Consulter le guide Dépannage
- Vérifier les GitHub Issues
- Contacter l'équipe de support technique