zen/core

Files

T

hykocx 54c4ad058d docs: translate INSTALL.md to French and add npm registry step

- Translate all installation instructions from English to French
- Add new step to configure the npm registry with a `.npmrc` file
- Renumber steps accordingly (now 6 steps instead of 5)

2026-04-12 14:37:33 -04:00

1.3 KiB

Raw Blame History

Installation

1. Configurer le registre npm

Créer un fichier .npmrc à la racine du projet avec le contenu suivant :

@hykocx:registry=https://git.hyko.cx/api/packages/hykocx/npm/

2. Installer le package

npm install @hykocx/zen

3. Installer les styles

Ajouter la ligne suivante dans le fichier globals.css :

@import '@hykocx/zen/styles/zen.css';

4. Ajouter ZenProvider au layout racine

Entourer l'application avec ZenProvider dans le layout racine pour activer les notifications toast globalement :

// app/layout.js
import './globals.css';
import { ZenProvider } from '@hykocx/zen/provider';

export const metadata = {
  title: 'My App',
};

export default function RootLayout({ children }) {
  return (
    <html lang="en">
      <body>
        <ZenProvider>
          {children}
        </ZenProvider>
      </body>
    </html>
  );
}

5. Configurer les variables d'environnement

Consulter le fichier .env.example pour les variables d'environnement à ajouter dans le fichier .env.

6. Initialiser la base de données

npx zen-db init

Configuration

Configuration rapide

On peut créer tous les fichiers requis avec une seule commande :

npx zen-setup init

1.3 KiB Raw Blame History