Démarrage

Installation

Mettez votre projet en route en moins de cinq minutes. Vous aurez besoin de Node.js 18+ et npm (ou pnpm / yarn).

Prérequis

  • Node.jsVersion 18 ou supérieure
  • npm / pnpm / yarnGestionnaire de paquets de votre choix
  • GitPour cloner le dépôt

Cloner le dépôt

Forkez ou clonez directement le dépôt GitHub :

Terminal
git clone https://github.com/benchambolle/onyx mon-site
cd mon-site
npm install

Variables d'environnement

Créez un fichier .env.local à la racine du projet à partir de l'exemple fourni :

Terminal
cp .env.example .env.local

Renseignez les valeurs suivantes :

.env.local
# Formulaire de contact (optionnel)
RESEND_API_KEY=re_xxxxxxxxxxxxxxxxxx
CONTACT_EMAIL=vous@votredomaine.fr
Les variables d'environnement sont uniquement nécessaires pour le formulaire de contact. Sans elles, toutes les autres fonctionnalités du site fonctionnent normalement.

Démarrer le serveur de développement

Terminal
npm run dev

Le site est disponible sur http://localhost:3000. Les modifications sont rechargées à chaud.

Vérifier le build de production

Avant de déployer, assurez-vous que le build compile sans erreur :

Terminal
npm run build

Gestionnaires alternatifs

pnpm
pnpm install
pnpm dev