Démarrage rapide

Suivez ces étapes pour configurer votre environnement de développement.

Cloner le dépôt

Clonez le dépôt NuxSaaS sur votre machine locale :

git clone https://github.com/NuxSaaS/NuxSaaS.git
cd NuxSaaS

Utiliser Node.js v22 LTS

Utilisez nvm pour installer Node.js v22 LTS :

nvm use

Cette commande lit le fichier .nvmrc et bascule vers la version de Node.js spécifiée (v22 LTS).

Installer les dépendances

Installez les dépendances du projet avec npm, ou utilisez le gestionnaire de paquets de votre choix :

npm install

Configurer les variables d'environnement

Copiez le fichier d'exemple d'environnement et configurez vos paramètres locaux :

cp .env.example .env

Vous devrez éditer le fichier .env pour ajouter vos identifiants de base de données, clés API (par exemple Stripe, Resend), et autres configurations nécessaires.

# Description : Exemple de fichier .env
NUXT_NITRO_PRESET=node-server # node-server ou cloudflare-module

# Cloudflare Hyperdrive ID, requis lors de l'utilisation de cloudflare-module
NUXT_CF_HYPERDRIVE_ID=cloudflare-hyperdrive-id

# Application
NUXT_APP_URL=http://localhost:3000 # URL de base de votre application
NUXT_APP_NAME=NuxSaaS
NUXT_APP_ENV=development
NUXT_APP_NOTIFY_EMAIL="[email protected]"
NUXT_APP_CONTACT_EMAIL="[email protected]"
NUXT_APP_REPO=https://github.com/NuxSaaS/NuxSaaS

NUXT_BETTER_AUTH_SECRET='' # Clé secrète pour JWT

# Base de données, requis lors de l'utilisation du preset node-server
# Vous devez créer une base nommée nuxsaas ou un autre nom de votre choix
NUXT_DATABASE_URL=postgres://postgres:@localhost:5432/nuxsaas 
# Redis, requis lors de l'utilisation du preset node-server
NUXT_REDIS_URL=redis://localhost:6379

# GitHub
NUXT_GH_CLIENT_ID=your-github-client-id
NUXT_GH_CLIENT_SECRET=your-github-client-secret

# Google
NUXT_GOOGLE_CLIENT_ID=your-google-client-id
NUXT_GOOGLE_CLIENT_SECRET=your-google-client-secret

# Resend
NUXT_RESEND_API_KEY=your-resend-api-key

# Stripe
NUXT_STRIPE_SECRET_KEY=your-stripe-secret-key
NUXT_STRIPE_WEBHOOK_SECRET=your-stripe-webhook-key
NUXT_STRIPE_PRICE_ID_PRO_MONTH=your-stripe-price-id-pro-month
NUXT_STRIPE_PRICE_ID_PRO_YEAR=your-stripe-price-id-pro-year

Générer et appliquer les migrations de base de données

Générez le schéma de la base de données à partir de vos modèles et appliquez les migrations :

npm run db:generate
npm run db:migrate

Démarrer le serveur de développement

npm run dev

Votre application devrait maintenant fonctionner en local, généralement sur http://localhost:3000.